From 1ed6b989b43331e23a645baf87e46bb4fadd8ccc Mon Sep 17 00:00:00 2001 From: ack-bot <82905295+ack-bot@users.noreply.github.com> Date: Mon, 11 Mar 2024 01:08:45 +0000 Subject: [PATCH] Deployed 7053f09 --- 404.html | 2 +- blog/index.html | 2 +- blog/say-hello-to-doks/index.html | 2 +- contributors/henk-verlinde/index.html | 2 +- contributors/index.html | 2 +- docs/community/background/index.html | 2 +- docs/community/discussions/index.html | 2 +- docs/community/faq/index.html | 2 +- docs/community/how-it-works/index.html | 2 +- docs/community/overview/index.html | 2 +- docs/community/releases/index.html | 2 +- docs/community/services/index.html | 4 ++-- docs/contributor-docs/api-inference/index.html | 2 +- docs/contributor-docs/building-controller/index.html | 2 +- docs/contributor-docs/code-generation/index.html | 2 +- docs/contributor-docs/code-generator-config/index.html | 2 +- docs/contributor-docs/code-organization/index.html | 2 +- docs/contributor-docs/operatorhub-onboarding/index.html | 2 +- docs/contributor-docs/overview/index.html | 2 +- docs/contributor-docs/release/index.html | 2 +- docs/contributor-docs/setup/index.html | 2 +- docs/contributor-docs/tenets/index.html | 2 +- docs/contributor-docs/testing/index.html | 2 +- docs/index.html | 2 +- docs/tutorials/apigatewayv2-reference-example/index.html | 2 +- docs/tutorials/aurora-serverless-v2/index.html | 2 +- docs/tutorials/autoscaling-example/index.html | 2 +- docs/tutorials/ec2-example/index.html | 2 +- docs/tutorials/emr-on-eks-example/index.html | 2 +- docs/tutorials/eventbridge-example/index.html | 2 +- docs/tutorials/lambda-oci-example/index.html | 2 +- docs/tutorials/memorydb-example/index.html | 2 +- docs/tutorials/pipes-example/index.html | 2 +- docs/tutorials/rds-example/index.html | 2 +- docs/tutorials/sagemaker-example/index.html | 2 +- docs/tutorials/sqs-example/index.html | 2 +- docs/user-docs/ack-tags/index.html | 2 +- docs/user-docs/adopted-resource/index.html | 2 +- docs/user-docs/authentication/index.html | 2 +- docs/user-docs/authorization/index.html | 2 +- docs/user-docs/cleanup/index.html | 2 +- docs/user-docs/cross-account-resource-management/index.html | 2 +- docs/user-docs/deletion-policy/index.html | 2 +- docs/user-docs/drift-recovery/index.html | 2 +- docs/user-docs/field-export/index.html | 2 +- docs/user-docs/install/index.html | 2 +- docs/user-docs/irsa/index.html | 2 +- docs/user-docs/leader-election/index.html | 2 +- docs/user-docs/multi-region-resource-management/index.html | 2 +- docs/user-docs/openshift/index.html | 2 +- docs/user-docs/resource-crud/index.html | 2 +- index.html | 2 +- ...373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js | 2 +- reference/acm/v1alpha1/certificate/index.html | 2 +- reference/acmpca/v1alpha1/certificate/index.html | 2 +- reference/acmpca/v1alpha1/certificateauthority/index.html | 2 +- .../acmpca/v1alpha1/certificateauthorityactivation/index.html | 2 +- reference/apigatewayv2/v1alpha1/api/index.html | 2 +- reference/apigatewayv2/v1alpha1/authorizer/index.html | 2 +- reference/apigatewayv2/v1alpha1/deployment/index.html | 2 +- reference/apigatewayv2/v1alpha1/integration/index.html | 2 +- reference/apigatewayv2/v1alpha1/route/index.html | 2 +- reference/apigatewayv2/v1alpha1/stage/index.html | 2 +- reference/apigatewayv2/v1alpha1/vpclink/index.html | 2 +- .../applicationautoscaling/v1alpha1/scalabletarget/index.html | 2 +- .../applicationautoscaling/v1alpha1/scalingpolicy/index.html | 2 +- reference/cloudfront/v1alpha1/cachepolicy/index.html | 2 +- reference/cloudfront/v1alpha1/distribution/index.html | 2 +- reference/cloudfront/v1alpha1/function/index.html | 2 +- reference/cloudfront/v1alpha1/originrequestpolicy/index.html | 2 +- .../cloudfront/v1alpha1/responseheaderspolicy/index.html | 2 +- reference/cloudtrail/v1alpha1/eventdatastore/index.html | 2 +- reference/cloudtrail/v1alpha1/trail/index.html | 2 +- reference/cloudwatch/v1alpha1/metricalarm/index.html | 2 +- reference/cloudwatchlogs/v1alpha1/loggroup/index.html | 2 +- reference/common/v1alpha1/adoptedresource/index.html | 2 +- reference/common/v1alpha1/fieldexport/index.html | 2 +- reference/documentdb/v1alpha1/dbcluster/index.html | 2 +- reference/documentdb/v1alpha1/dbinstance/index.html | 2 +- reference/documentdb/v1alpha1/dbsubnetgroup/index.html | 2 +- reference/dynamodb/v1alpha1/backup/index.html | 2 +- reference/dynamodb/v1alpha1/globaltable/index.html | 2 +- reference/dynamodb/v1alpha1/table/index.html | 2 +- reference/ec2/v1alpha1/dhcpoptions/index.html | 2 +- reference/ec2/v1alpha1/elasticipaddress/index.html | 2 +- reference/ec2/v1alpha1/flowlog/index.html | 2 +- reference/ec2/v1alpha1/instance/index.html | 2 +- reference/ec2/v1alpha1/internetgateway/index.html | 2 +- reference/ec2/v1alpha1/natgateway/index.html | 2 +- reference/ec2/v1alpha1/networkacl/index.html | 2 +- reference/ec2/v1alpha1/routetable/index.html | 2 +- reference/ec2/v1alpha1/securitygroup/index.html | 2 +- reference/ec2/v1alpha1/subnet/index.html | 2 +- reference/ec2/v1alpha1/transitgateway/index.html | 2 +- reference/ec2/v1alpha1/vpc/index.html | 2 +- reference/ec2/v1alpha1/vpcendpoint/index.html | 2 +- .../ec2/v1alpha1/vpcendpointserviceconfiguration/index.html | 2 +- reference/ec2/v1alpha1/vpcpeeringconnection/index.html | 2 +- reference/ecr/v1alpha1/pullthroughcacherule/index.html | 2 +- reference/ecr/v1alpha1/repository/index.html | 2 +- reference/ecs/v1alpha1/cluster/index.html | 2 +- reference/ecs/v1alpha1/service/index.html | 2 +- reference/ecs/v1alpha1/taskdefinition/index.html | 2 +- reference/efs/v1alpha1/accesspoint/index.html | 2 +- reference/efs/v1alpha1/filesystem/index.html | 2 +- reference/efs/v1alpha1/mounttarget/index.html | 2 +- reference/eks/v1alpha1/accessentry/index.html | 2 +- reference/eks/v1alpha1/addon/index.html | 2 +- reference/eks/v1alpha1/cluster/index.html | 2 +- reference/eks/v1alpha1/fargateprofile/index.html | 2 +- reference/eks/v1alpha1/nodegroup/index.html | 2 +- reference/eks/v1alpha1/podidentityassociation/index.html | 2 +- reference/elasticache/v1alpha1/cacheparametergroup/index.html | 2 +- reference/elasticache/v1alpha1/cachesubnetgroup/index.html | 2 +- reference/elasticache/v1alpha1/replicationgroup/index.html | 2 +- reference/elasticache/v1alpha1/snapshot/index.html | 2 +- reference/elasticache/v1alpha1/user/index.html | 2 +- reference/elasticache/v1alpha1/usergroup/index.html | 2 +- reference/emrcontainers/v1alpha1/jobrun/index.html | 2 +- reference/emrcontainers/v1alpha1/virtualcluster/index.html | 2 +- reference/eventbridge/v1alpha1/archive/index.html | 2 +- reference/eventbridge/v1alpha1/endpoint/index.html | 2 +- reference/eventbridge/v1alpha1/eventbus/index.html | 2 +- reference/eventbridge/v1alpha1/rule/index.html | 2 +- reference/iam/v1alpha1/group/index.html | 2 +- reference/iam/v1alpha1/instanceprofile/index.html | 2 +- reference/iam/v1alpha1/openidconnectprovider/index.html | 2 +- reference/iam/v1alpha1/policy/index.html | 2 +- reference/iam/v1alpha1/role/index.html | 2 +- reference/iam/v1alpha1/user/index.html | 2 +- reference/index.html | 2 +- reference/kafka/v1alpha1/cluster/index.html | 2 +- reference/keyspaces/v1alpha1/keyspace/index.html | 2 +- reference/keyspaces/v1alpha1/table/index.html | 2 +- reference/kinesis/v1alpha1/stream/index.html | 2 +- reference/kms/v1alpha1/alias/index.html | 2 +- reference/kms/v1alpha1/grant/index.html | 2 +- reference/kms/v1alpha1/key/index.html | 2 +- reference/lambda/v1alpha1/alias/index.html | 2 +- reference/lambda/v1alpha1/codesigningconfig/index.html | 2 +- reference/lambda/v1alpha1/eventsourcemapping/index.html | 2 +- reference/lambda/v1alpha1/function/index.html | 2 +- reference/lambda/v1alpha1/functionurlconfig/index.html | 2 +- reference/lambda/v1alpha1/layerversion/index.html | 2 +- reference/lambda/v1alpha1/version/index.html | 2 +- reference/memorydb/v1alpha1/acl/index.html | 2 +- reference/memorydb/v1alpha1/cluster/index.html | 2 +- reference/memorydb/v1alpha1/parametergroup/index.html | 2 +- reference/memorydb/v1alpha1/snapshot/index.html | 2 +- reference/memorydb/v1alpha1/subnetgroup/index.html | 2 +- reference/memorydb/v1alpha1/user/index.html | 2 +- reference/mq/v1alpha1/broker/index.html | 2 +- reference/networkfirewall/v1alpha1/firewall/index.html | 2 +- reference/networkfirewall/v1alpha1/firewallpolicy/index.html | 2 +- reference/networkfirewall/v1alpha1/rulegroup/index.html | 2 +- reference/opensearchservice/v1alpha1/domain/index.html | 2 +- .../organizations/v1alpha1/organizationalunit/index.html | 2 +- reference/pipes/v1alpha1/pipe/index.html | 2 +- .../v1alpha1/alertmanagerdefinition/index.html | 2 +- .../v1alpha1/loggingconfiguration/index.html | 2 +- .../prometheusservice/v1alpha1/rulegroupsnamespace/index.html | 2 +- reference/prometheusservice/v1alpha1/workspace/index.html | 2 +- reference/rds/v1alpha1/dbcluster/index.html | 2 +- reference/rds/v1alpha1/dbclusterparametergroup/index.html | 2 +- reference/rds/v1alpha1/dbinstance/index.html | 2 +- reference/rds/v1alpha1/dbparametergroup/index.html | 2 +- reference/rds/v1alpha1/dbproxy/index.html | 2 +- reference/rds/v1alpha1/dbsubnetgroup/index.html | 2 +- reference/rds/v1alpha1/globalcluster/index.html | 2 +- reference/route53/v1alpha1/hostedzone/index.html | 2 +- reference/route53/v1alpha1/recordset/index.html | 2 +- .../route53resolver/v1alpha1/resolverendpoint/index.html | 2 +- reference/route53resolver/v1alpha1/resolverrule/index.html | 2 +- reference/s3/v1alpha1/bucket/index.html | 2 +- reference/sagemaker/v1alpha1/app/index.html | 2 +- .../sagemaker/v1alpha1/dataqualityjobdefinition/index.html | 2 +- reference/sagemaker/v1alpha1/domain/index.html | 2 +- reference/sagemaker/v1alpha1/endpoint/index.html | 2 +- reference/sagemaker/v1alpha1/endpointconfig/index.html | 2 +- reference/sagemaker/v1alpha1/featuregroup/index.html | 2 +- .../sagemaker/v1alpha1/hyperparametertuningjob/index.html | 2 +- reference/sagemaker/v1alpha1/model/index.html | 2 +- .../sagemaker/v1alpha1/modelbiasjobdefinition/index.html | 2 +- .../v1alpha1/modelexplainabilityjobdefinition/index.html | 2 +- reference/sagemaker/v1alpha1/modelpackage/index.html | 2 +- reference/sagemaker/v1alpha1/modelpackagegroup/index.html | 2 +- .../sagemaker/v1alpha1/modelqualityjobdefinition/index.html | 2 +- reference/sagemaker/v1alpha1/monitoringschedule/index.html | 2 +- reference/sagemaker/v1alpha1/notebookinstance/index.html | 2 +- .../v1alpha1/notebookinstancelifecycleconfig/index.html | 2 +- reference/sagemaker/v1alpha1/pipeline/index.html | 2 +- reference/sagemaker/v1alpha1/pipelineexecution/index.html | 2 +- reference/sagemaker/v1alpha1/processingjob/index.html | 2 +- reference/sagemaker/v1alpha1/trainingjob/index.html | 2 +- reference/sagemaker/v1alpha1/transformjob/index.html | 2 +- reference/sagemaker/v1alpha1/userprofile/index.html | 2 +- reference/secretsmanager/v1alpha1/secret/index.html | 2 +- reference/sfn/v1alpha1/activity/index.html | 2 +- reference/sfn/v1alpha1/statemachine/index.html | 2 +- reference/sns/v1alpha1/platformapplication/index.html | 2 +- reference/sns/v1alpha1/platformendpoint/index.html | 2 +- reference/sns/v1alpha1/subscription/index.html | 2 +- reference/sns/v1alpha1/topic/index.html | 2 +- reference/sqs/v1alpha1/queue/index.html | 2 +- 204 files changed, 205 insertions(+), 205 deletions(-) rename index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js => index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js (99%) diff --git a/404.html b/404.html index b1b3d990ca..eff8ab1676 100644 --- a/404.html +++ b/404.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row justify-content-center"><div class="col-md-12 col-lg-10 col-xl-8"><article><h1 class=text-center>Page not found :(</h1><p class=text-center>The page you are looking for doesn't exist or has been moved.</p></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/blog/index.html b/blog/index.html index cb18674d0b..7249c9ab68 100644 --- a/blog/index.html +++ b/blog/index.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row justify-content-center"><div class="col-md-12 col-lg-10 col-xl-8"><article><h1 class=text-center>Blog</h1><div class=text-center></div><div class=card-list><div class=card><div class=card-body><h2 class=h3><a class="stretched-link text-body" href=https://aws-controllers-k8s.github.io/community/blog/say-hello-to-doks/>Say hello to Doks 👋</a></h2><p>Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.</p><p><small>Posted November 4, 2020 by <a class="stretched-link position-relative" href=https://aws-controllers-k8s.github.io/community/contributors/henk-verlinde/>Henk Verlinde</a> ‐ <strong>0 min read</strong></small><p></div></div></div></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/blog/say-hello-to-doks/index.html b/blog/say-hello-to-doks/index.html index 03940a9f99..02d73fcb60 100644 --- a/blog/say-hello-to-doks/index.html +++ b/blog/say-hello-to-doks/index.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row justify-content-center"><div class="col-md-12 col-lg-10 col-xl-8"><article><div class=blog-header><h1>Say hello to Doks 👋</h1><p><small>Posted November 4, 2020 by <a class="stretched-link position-relative" href=https://aws-controllers-k8s.github.io/community/contributors/henk-verlinde/>Henk Verlinde</a> ‐ <strong>0 min read</strong></small><p></div><p class=lead>Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.</p></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/contributors/henk-verlinde/index.html b/contributors/henk-verlinde/index.html index 097d048960..eb074b1fbe 100644 --- a/contributors/henk-verlinde/index.html +++ b/contributors/henk-verlinde/index.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row justify-content-center"><div class="col-md-12 col-lg-10 col-xl-8"><article><h1 class=text-center>Henk Verlinde</h1><div class=text-center></div><div class=card-list><div class=card><div class=card-body><h2 class=h3><a class="stretched-link text-body" href=https://aws-controllers-k8s.github.io/community/blog/say-hello-to-doks/>Say hello to Doks 👋</a></h2><p>Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.</p><p><small>Posted November 4, 2020 by <a class="stretched-link position-relative" href=https://aws-controllers-k8s.github.io/community/contributors/henk-verlinde/>Henk Verlinde</a> ‐ <strong>0 min read</strong></small><p></div></div></div></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/contributors/index.html b/contributors/index.html index 4718d75dff..85c185cd41 100644 --- a/contributors/index.html +++ b/contributors/index.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><div class="row justify-content-center"><div class="col-md-12 col-lg-10 col-xl-8"><article><h1 class=text-center>Contributors</h1><div class=text-center></div><div class=card-list><div class=card><div class=card-body><h2 class=h3><a class="stretched-link text-body" href=https://aws-controllers-k8s.github.io/community/contributors/henk-verlinde/>Henk Verlinde</a></h2></div></div></div></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/background/index.html b/docs/community/background/index.html index 349882861e..992d199dc1 100644 --- a/docs/community/background/index.html +++ b/docs/community/background/index.html @@ -9,4 +9,4 @@ Discussion</button><div class="collapse show" id=section-discussion><ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small"><li><a class="docs-link rounded active" href=https://aws-controllers-k8s.github.io/community/docs/community/background/>Background</a></li><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/faq/>FAQ</a></li><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/discussions/>Discussions</a></li></ul></div></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><hr><span class=small><nav id=TableOfContents><ul><li><a href=#existing-custom-controllers>Existing custom controllers</a></li><li><a href=#related-projects>Related projects</a></li></ul></nav></span></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Background</h1><p class=lead></p><p>In 10/2018 Chris Hein <a href=https://aws.amazon.com/blogs/opensource/aws-service-operator-kubernetes-available/>introduced</a> the AWS Service Operator (ASO) project. We reviewed the feedback from the community and stakeholders and in 08/2019 <a href=https://github.com/aws/containers-roadmap/issues/456>decided</a> to relaunch ASO as a first-tier open source project with concrete commitments from the container service team. In this process, we renamed the project to AWS Controllers for Kubernetes (ACK).</p><p>The tenets for the relaunch were:</p><ol><li>ACK is a community-driven project, based on a governance model defining roles and responsibilities.</li><li>ACK is optimized for production usage with full test coverage including performance and scalability test suites.</li><li>ACK strives to be the only codebase exposing AWS services via a Kubernetes operator.</li></ol><p>Since then, we worked on <a href="https://github.com/aws/aws-controllers-k8s/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adesign">design issues</a> and gathering feedback around which services to prioritize.</p><h2 id=existing-custom-controllers>Existing custom controllers<a href=#existing-custom-controllers class=anchor aria-hidden=true>#</a></h2><p>AWS service teams use custom controllers, webhooks, and operators for different use cases and based on different approaches. Examples include:</p><ul><li><a href=https://github.com/aws/amazon-sagemaker-operator-for-k8s>SageMaker operator</a>, allowing to use SageMaker from Kubernetes</li><li><a href=https://github.com/aws/aws-app-mesh-controller-for-k8s>App Mesh controller</a>, managing App Mesh resources from Kubernetes</li><li><a href=https://github.com/aws/amazon-eks-pod-identity-webhook>EKS Pod Identity Webhook</a>, providing IAM roles for service accounts functionality</li></ul><p>While the autonomy in the different teams and project allows for rapid iterations and innovations, there are some drawbacks associated with it:</p><ul><li>The UX differs and that can lead to frustration when adopting an offering.</li><li>A consistent quality bar across the different offerings is hard to establish and to verify.</li><li>It’s wasteful to re-invent the plumbing and necessary infrastructure (testing, etc.).</li></ul><p>Above is the motivation for our 3rd tenet: we want to make sure that there is a common framework, implementing good practices as put forward, for example, in the <a href=https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/>Operator Developer Guide</a> or in the <a href=https://programming-kubernetes.info/>Programming Kubernetes</a> book.</p><h2 id=related-projects>Related projects<a href=#related-projects class=anchor aria-hidden=true>#</a></h2><p>Outside of AWS, there are projects that share similar goals we have with the ASO, for example:</p><ul><li><a href=https://github.com/crossplane/provider-aws>Crossplane</a></li><li><a href=https://github.com/yard-turkey/aws-s3-provisioner>aws-s3-provisioner</a></li></ul><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/background.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/discussions/index.html b/docs/community/discussions/index.html index 5d2e90d995..9790af35cf 100644 --- a/docs/community/discussions/index.html +++ b/docs/community/discussions/index.html @@ -9,4 +9,4 @@ Discussion</button><div class="collapse show" id=section-discussion><ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small"><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/background/>Background</a></li><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/faq/>FAQ</a></li><li><a class="docs-link rounded active" href=https://aws-controllers-k8s.github.io/community/docs/community/discussions/>Discussions</a></li></ul></div></li></ul></nav></div><nav class="docs-toc d-none d-xl-block col-xl-3" aria-label="Secondary navigation"><div class=page-links><h3>On this page</h3><hr><span class=small><nav id=TableOfContents></nav></span></div></nav><main class="docs-content col-lg-11 col-xl-9"><h1>Discussions</h1><p class=lead></p><p>For discussions, please use the <code>#aws-controllers-k8s</code> channel on the <a href=https://kubernetes.slack.com/>Kubernetes Slack community</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/discussions.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/faq/index.html b/docs/community/faq/index.html index e5ca3ff6b2..e9cc3db886 100644 --- a/docs/community/faq/index.html +++ b/docs/community/faq/index.html @@ -22,4 +22,4 @@ For now, if you’re a developer, you can check out the <a href=../../contributor-docs/overview/>contributor docs</a>.</div></div><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/faq.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/how-it-works/index.html b/docs/community/how-it-works/index.html index 98702d3ca5..d229b4c176 100644 --- a/docs/community/how-it-works/index.html +++ b/docs/community/how-it-works/index.html @@ -38,4 +38,4 @@ <a href=../../user-docs/drift-recovery>Recovering from Drift</a></p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/how-it-works.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/overview/index.html b/docs/community/overview/index.html index 0d37b2b714..aac3fd5880 100644 --- a/docs/community/overview/index.html +++ b/docs/community/overview/index.html @@ -11,4 +11,4 @@ for a particular AWS API.</div></div><p>Container images for ACK service controllers can be found in the <a href=https://gallery.ecr.aws/aws-controllers-k8s>ACK registry within the Amazon ECR Public Gallery</a>. To find a container image for a specific service, you can go to <code>gallery.ecr.aws/aws-controllers-k8s/$SERVICENAME-controller</code>. For example, the link to the ACK service controller container image for Amazon Simple Storage Service (Amazon S3) is <a href=https://gallery.ecr.aws/aws-controllers-k8s/s3-controller><code>gallery.ecr.aws/aws-controllers-k8s/s3-controller</code></a>.</p><p>Individual ACK service controllers are tagged with their release version. You can find image URIs for different releases under the <code>Image tags</code> section in the image repository on the ECR Public Gallery.</p><div class="hint d-flex flex-column border-start my-4 border-4 hint-info"><div class="hint-title p-2 flex flex-row flex-items-center">Be sure to specify a release version</div><div class="hint-body p-2 small">You must always specify a version tag when referencing an ACK service controller image.</div></div><p>In accordance with <a href=https://vsupalov.com/docker-latest-tag/>best practices</a>, we do not include <code>:latest</code> default tags for our image repositories.</p><h2 id=next-steps>Next steps<a href=#next-steps class=anchor aria-hidden=true>#</a></h2><p>This guide assumes that you have access to a Kubernetes cluster. You do not need to use the Amazon Elastic Kubernetes Service (Amazon EKS) to get started with ACK service controllers. If you do not yet have a Kubernetes cluster and would like to use Amazon EKS, you can visit the <a href=https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html>Amazon EKS Setup</a> guide.</p><p>Once you have access to a Kubernetes cluster, you can <a href=../../user-docs/install/>install the ACK service controller of your choice</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/overview.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/releases/index.html b/docs/community/releases/index.html index 612948d89d..51e2297140 100644 --- a/docs/community/releases/index.html +++ b/docs/community/releases/index.html @@ -113,4 +113,4 @@ deprecation period has elapsed</em>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/releases.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/community/services/index.html b/docs/community/services/index.html index 6a10b309e4..52e7ae1e0b 100644 --- a/docs/community/services/index.html +++ b/docs/community/services/index.html @@ -13,8 +13,8 @@ series of service controllers, one for each AWS service API. Each individual ACK service controller is released separately. Please see the <a href=../releases>release documentation</a> for information on how we version and -release ACK service controllers.</div></div><table><thead><tr><th style=text-align:left>Maintenance Phase</th><th style=text-align:right># Services</th></tr></thead><tbody><tr><td style=text-align:left><code>PREVIEW</code></td><td style=text-align:right>18</td></tr><tr><td style=text-align:left><code>GENERAL AVAILABILITY</code></td><td style=text-align:right>20</td></tr></tbody></table><table><thead><tr><th style=text-align:right>AWS Service</th><th style=text-align:right>Project Stage</th><th style=text-align:right>Maintenance Phase</th><th style=text-align:right>Latest Version</th></tr></thead><tbody><tr><td style=text-align:right>Amazon <a href=#amazon-acm>ACM</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/acm-controller/releases/tag/v0.0.14>0.0.14</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-prometheus-service>Prometheus Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/prometheusservice-controller/releases/tag/v1.2.9>1.2.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-api-gateway>API Gateway</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-apigatewayv2>ApiGatewayV2</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/apigatewayv2-controller/releases/tag/v1.0.10>1.0.10</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-application-auto-scaling>Application Auto Scaling</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/applicationautoscaling-controller/releases/tag/v1.0.12>1.0.12</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-app-runner>App Runner</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-athena>Athena</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-auto-scaling-plans>Auto Scaling Plans</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-auto-scaling>Auto Scaling</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-backup>Backup</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudfront>CloudFront</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudfront-controller/releases/tag/v0.0.9>0.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudtrail>CloudTrail</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudtrail-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cognito-identity-provider>Cognito Identity Provider</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-dynamodb>DynamoDB</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/dynamodb-controller/releases/tag/v1.2.9>1.2.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ec2>EC2</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ec2-controller/releases/tag/v1.2.4>1.2.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ecr>ECR</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ecr-controller/releases/tag/v1.0.13>1.0.13</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ecs>ECS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ecs-controller/releases/tag/v0.0.4>0.0.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-eks>EKS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/eks-controller/releases/tag/v1.3.2>1.3.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-elasticache>ElastiCache</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/elasticache-controller/releases/tag/v0.0.29>0.0.29</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-efs>EFS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/efs-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ses>SES</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-emr-containers>EMR Containers</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/emrcontainers-controller/releases/tag/v1.0.8>1.0.8</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-elasticsearch-service>Elasticsearch Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/elasticsearchservice-controller/releases/tag/v0.0.2>0.0.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-eventbridge>EventBridge</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/eventbridge-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-fsx>FSx</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-iam>IAM</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/iam-controller/releases/tag/v1.3.5>1.3.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kafka>Kafka</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kafka-controller/releases/tag/v0.0.3>0.0.3</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-keyspaces>Keyspaces</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/keyspaces-controller/releases/tag/v0.0.11>0.0.11</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kinesis>Kinesis</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kinesis-controller/releases/tag/v0.0.13>0.0.13</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kms>KMS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kms-controller/releases/tag/v1.0.11>1.0.11</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-lambda>Lambda</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/lambda-controller/releases/tag/v1.4.2>1.4.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudwatch-logs>CloudWatch Logs</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudwatchlogs-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-memorydb>MemoryDB</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/memorydb-controller/releases/tag/v1.0.2>1.0.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudwatch>CloudWatch</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudwatch-controller/releases/tag/v0.0.6>0.0.6</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-mq>MQ</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/mq-controller/releases/tag/v0.0.32>0.0.32</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-neptune>Neptune</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-network-firewall>Network Firewall</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/networkfirewall-controller/releases/tag/v0.0.3>0.0.3</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-opensearch-service>OpenSearch Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/opensearchservice-controller/releases/tag/v0.0.22>0.0.22</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-organizations>Organizations</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/organizations-controller/releases/tag/v0.0.4>0.0.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ram>RAM</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-recycle-bin>Recycle Bin</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-rds>RDS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/rds-controller/releases/tag/v1.2.1>1.2.1</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-route-53>Route 53</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/route53-controller/releases/tag/v0.0.12>0.0.12</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-route53resolver>Route53Resolver</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/route53resolver-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-s3>S3</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/s3-controller/releases/tag/v1.0.10>1.0.10</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sagemaker>SageMaker</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sagemaker-controller/releases/tag/v1.2.7>1.2.7</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-secrets-manager>Secrets Manager</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/secretsmanager-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-service-catalog>Service Catalog</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sns>SNS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sns-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sqs>SQS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sqs-controller/releases/tag/v1.0.11>1.0.11</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ssm>SSM</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-sfn>SFN</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sfn-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-wafv2>WAFV2</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr></tbody></table><div class="hint d-flex flex-column border-start my-4 border-4 hint-info"><div class="hint-title p-2 flex flex-row flex-items-center">Don’t see a service listed?</div><div class="hint-body p-2 small">If you don’t see a particular AWS service listed, feel free to +release ACK service controllers.</div></div><table><thead><tr><th style=text-align:left>Maintenance Phase</th><th style=text-align:right># Services</th></tr></thead><tbody><tr><td style=text-align:left><code>PREVIEW</code></td><td style=text-align:right>18</td></tr><tr><td style=text-align:left><code>GENERAL AVAILABILITY</code></td><td style=text-align:right>20</td></tr></tbody></table><table><thead><tr><th style=text-align:right>AWS Service</th><th style=text-align:right>Project Stage</th><th style=text-align:right>Maintenance Phase</th><th style=text-align:right>Latest Version</th></tr></thead><tbody><tr><td style=text-align:right>Amazon <a href=#amazon-acm>ACM</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/acm-controller/releases/tag/v0.0.14>0.0.14</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-prometheus-service>Prometheus Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/prometheusservice-controller/releases/tag/v1.2.9>1.2.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-api-gateway>API Gateway</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-apigatewayv2>ApiGatewayV2</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/apigatewayv2-controller/releases/tag/v1.0.10>1.0.10</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-application-auto-scaling>Application Auto Scaling</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/applicationautoscaling-controller/releases/tag/v1.0.12>1.0.12</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-app-runner>App Runner</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-athena>Athena</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-auto-scaling-plans>Auto Scaling Plans</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-auto-scaling>Auto Scaling</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-backup>Backup</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudfront>CloudFront</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudfront-controller/releases/tag/v0.0.9>0.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudtrail>CloudTrail</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudtrail-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cognito-identity-provider>Cognito Identity Provider</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-dynamodb>DynamoDB</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/dynamodb-controller/releases/tag/v1.2.9>1.2.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ec2>EC2</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ec2-controller/releases/tag/v1.2.4>1.2.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ecr>ECR</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ecr-controller/releases/tag/v1.0.13>1.0.13</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ecs>ECS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/ecs-controller/releases/tag/v0.0.4>0.0.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-eks>EKS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/eks-controller/releases/tag/v1.3.2>1.3.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-elasticache>ElastiCache</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/elasticache-controller/releases/tag/v0.0.29>0.0.29</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-efs>EFS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/efs-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ses>SES</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-emr-containers>EMR Containers</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/emrcontainers-controller/releases/tag/v1.0.8>1.0.8</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-elasticsearch-service>Elasticsearch Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/elasticsearchservice-controller/releases/tag/v0.0.2>0.0.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-eventbridge>EventBridge</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/eventbridge-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-fsx>FSx</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-iam>IAM</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/iam-controller/releases/tag/v1.3.5>1.3.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kafka>Kafka</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kafka-controller/releases/tag/v0.0.4>0.0.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-keyspaces>Keyspaces</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/keyspaces-controller/releases/tag/v0.0.11>0.0.11</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kinesis>Kinesis</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kinesis-controller/releases/tag/v0.0.13>0.0.13</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-kms>KMS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/kms-controller/releases/tag/v1.0.11>1.0.11</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-lambda>Lambda</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/lambda-controller/releases/tag/v1.4.2>1.4.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudwatch-logs>CloudWatch Logs</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudwatchlogs-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-memorydb>MemoryDB</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/memorydb-controller/releases/tag/v1.0.2>1.0.2</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-cloudwatch>CloudWatch</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/cloudwatch-controller/releases/tag/v0.0.6>0.0.6</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-mq>MQ</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/mq-controller/releases/tag/v0.0.32>0.0.32</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-neptune>Neptune</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-network-firewall>Network Firewall</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/networkfirewall-controller/releases/tag/v0.0.3>0.0.3</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-opensearch-service>OpenSearch Service</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/opensearchservice-controller/releases/tag/v0.0.22>0.0.22</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-organizations>Organizations</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/organizations-controller/releases/tag/v0.0.4>0.0.4</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ram>RAM</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-recycle-bin>Recycle Bin</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-rds>RDS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/rds-controller/releases/tag/v1.2.1>1.2.1</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-route-53>Route 53</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/route53-controller/releases/tag/v0.0.12>0.0.12</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-route53resolver>Route53Resolver</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/route53resolver-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-s3>S3</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/s3-controller/releases/tag/v1.0.10>1.0.10</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sagemaker>SageMaker</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sagemaker-controller/releases/tag/v1.2.7>1.2.7</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-secrets-manager>Secrets Manager</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>PREVIEW</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/secretsmanager-controller/releases/tag/v0.0.5>0.0.5</a></td></tr><tr><td style=text-align:right>AWS <a href=#aws-service-catalog>Service Catalog</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sns>SNS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sns-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-sqs>SQS</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sqs-controller/releases/tag/v1.0.11>1.0.11</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-ssm>SSM</a></td><td style=text-align:right><code>PLANNED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr><tr><td style=text-align:right>AWS <a href=#aws-sfn>SFN</a></td><td style=text-align:right><code>RELEASED</code></td><td style=text-align:right><code>GENERAL AVAILABILITY</code></td><td style=text-align:right><a href=https://github.com/aws-controllers-k8s/sfn-controller/releases/tag/v1.0.9>1.0.9</a></td></tr><tr><td style=text-align:right>Amazon <a href=#amazon-wafv2>WAFV2</a></td><td style=text-align:right><code>PROPOSED</code></td><td style=text-align:right><code>NONE</code></td><td style=text-align:right>n/a</td></tr></tbody></table><div class="hint d-flex flex-column border-start my-4 border-4 hint-info"><div class="hint-title p-2 flex flex-row flex-items-center">Don’t see a service listed?</div><div class="hint-body p-2 small">If you don’t see a particular AWS service listed, feel free to <a href="https://github.com/aws-controllers-k8s/community/issues/new?labels=Service+Controller&template=propose_new_controller.md&title=%5Bname%5D+service+controller">propose it</a>!</div></div><h2 id=amazon-acm>Amazon ACM<a href=#amazon-acm class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/acm-controller rel=noopener>https://github.com/aws-controllers-k8s/acm-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/482 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/482</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/acm-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/acm-chart</code></li></ul><h2 id=amazon-prometheus-service>Amazon Prometheus Service<a href=#amazon-prometheus-service class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/prometheusservice-controller rel=noopener>https://github.com/aws-controllers-k8s/prometheusservice-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/prometheusservice-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/prometheusservice-chart</code></li></ul><h2 id=amazon-api-gateway>Amazon API Gateway<a href=#amazon-api-gateway class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/apigateway-controller rel=noopener>https://github.com/aws-controllers-k8s/apigateway-controller</a></li><li>Current project stage: <code>PLANNED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1126 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1126</a></li></ul><h2 id=amazon-apigatewayv2>Amazon ApiGatewayV2<a href=#amazon-apigatewayv2 class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/apigatewayv2-controller rel=noopener>https://github.com/aws-controllers-k8s/apigatewayv2-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/apigatewayv2-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/apigatewayv2-chart</code></li></ul><h2 id=amazon-application-auto-scaling>Amazon Application Auto Scaling<a href=#amazon-application-auto-scaling class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/applicationautoscaling-controller rel=noopener>https://github.com/aws-controllers-k8s/applicationautoscaling-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/applicationautoscaling-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/applicationautoscaling-chart</code></li></ul><h2 id=aws-app-runner>AWS App Runner<a href=#aws-app-runner class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1616 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1616</a></li></ul><h2 id=amazon-athena>Amazon Athena<a href=#amazon-athena class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1597 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1597</a></li></ul><h2 id=aws-auto-scaling-plans>AWS Auto Scaling Plans<a href=#aws-auto-scaling-plans class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/590 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/590</a></li></ul><h2 id=amazon-auto-scaling>Amazon Auto Scaling<a href=#amazon-auto-scaling class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/autoscaling-controller rel=noopener>https://github.com/aws-controllers-k8s/autoscaling-controller</a></li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/588 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/588</a></li></ul><h2 id=aws-backup>AWS Backup<a href=#aws-backup class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/2023 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/2023</a></li></ul><h2 id=amazon-cloudfront>Amazon CloudFront<a href=#amazon-cloudfront class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/cloudfront-controller rel=noopener>https://github.com/aws-controllers-k8s/cloudfront-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/249 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/249</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/cloudfront-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/cloudfront-chart</code></li></ul><h2 id=amazon-cloudtrail>Amazon CloudTrail<a href=#amazon-cloudtrail class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/cloudtrail-controller rel=noopener>https://github.com/aws-controllers-k8s/cloudtrail-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/cloudtrail-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/cloudtrail-chart</code></li></ul><h2 id=amazon-cognito-identity-provider>Amazon Cognito Identity Provider<a href=#amazon-cognito-identity-provider class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PLANNED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1211 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1211</a></li></ul><h2 id=amazon-dynamodb>Amazon DynamoDB<a href=#amazon-dynamodb class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/dynamodb-controller rel=noopener>https://github.com/aws-controllers-k8s/dynamodb-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/dynamodb-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/dynamodb-chart</code></li></ul><h2 id=amazon-ec2>Amazon EC2<a href=#amazon-ec2 class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/ec2-controller rel=noopener>https://github.com/aws-controllers-k8s/ec2-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/490 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/490</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/ec2-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/ec2-chart</code></li></ul><h2 id=amazon-ecr>Amazon ECR<a href=#amazon-ecr class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/ecr-controller rel=noopener>https://github.com/aws-controllers-k8s/ecr-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/ecr-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/ecr-chart</code></li></ul><h2 id=amazon-ecs>Amazon ECS<a href=#amazon-ecs class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/ecs-controller rel=noopener>https://github.com/aws-controllers-k8s/ecs-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1592 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1592</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/ecs-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/ecs-chart</code></li></ul><h2 id=amazon-eks>Amazon EKS<a href=#amazon-eks class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/eks-controller rel=noopener>https://github.com/aws-controllers-k8s/eks-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/eks-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/eks-chart</code></li></ul><h2 id=amazon-elasticache>Amazon ElastiCache<a href=#amazon-elasticache class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/elasticache-controller rel=noopener>https://github.com/aws-controllers-k8s/elasticache-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/240 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/240</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/elasticache-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/elasticache-chart</code></li></ul><h2 id=amazon-efs>Amazon EFS<a href=#amazon-efs class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/efs-controller rel=noopener>https://github.com/aws-controllers-k8s/efs-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/328 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/328</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/efs-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/efs-chart</code></li></ul><h2 id=amazon-ses>Amazon SES<a href=#amazon-ses class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/493 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/493</a></li></ul><h2 id=amazon-emr-containers>Amazon EMR Containers<a href=#amazon-emr-containers class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/emrcontainers-controller rel=noopener>https://github.com/aws-controllers-k8s/emrcontainers-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/emrcontainers-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/emrcontainers-chart</code></li></ul><h2 id=amazon-elasticsearch-service>Amazon Elasticsearch Service<a href=#amazon-elasticsearch-service class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/elasticsearchservice-controller rel=noopener>https://github.com/aws-controllers-k8s/elasticsearchservice-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/elasticsearchservice-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/elasticsearchservice-chart</code></li></ul><h2 id=amazon-eventbridge>Amazon EventBridge<a href=#amazon-eventbridge class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/eventbridge-controller rel=noopener>https://github.com/aws-controllers-k8s/eventbridge-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/eventbridge-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/eventbridge-chart</code></li></ul><h2 id=amazon-fsx>Amazon FSx<a href=#amazon-fsx class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1485 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1485</a></li></ul><h2 id=amazon-iam>Amazon IAM<a href=#amazon-iam class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/iam-controller rel=noopener>https://github.com/aws-controllers-k8s/iam-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/iam-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/iam-chart</code></li></ul><h2 id=amazon-kafka>Amazon Kafka<a href=#amazon-kafka class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/kafka-controller rel=noopener>https://github.com/aws-controllers-k8s/kafka-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/348 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/348</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/kafka-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/kafka-chart</code></li></ul><h2 id=amazon-keyspaces>Amazon Keyspaces<a href=#amazon-keyspaces class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/keyspaces-controller rel=noopener>https://github.com/aws-controllers-k8s/keyspaces-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1801 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1801</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/keyspaces-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/keyspaces-chart</code></li></ul><h2 id=amazon-kinesis>Amazon Kinesis<a href=#amazon-kinesis class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/kinesis-controller rel=noopener>https://github.com/aws-controllers-k8s/kinesis-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/235 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/235</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/kinesis-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/kinesis-chart</code></li></ul><h2 id=amazon-kms>Amazon KMS<a href=#amazon-kms class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/kms-controller rel=noopener>https://github.com/aws-controllers-k8s/kms-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/kms-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/kms-chart</code></li></ul><h2 id=aws-lambda>AWS Lambda<a href=#aws-lambda class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/lambda-controller rel=noopener>https://github.com/aws-controllers-k8s/lambda-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/lambda-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/lambda-chart</code></li></ul><h2 id=amazon-cloudwatch-logs>Amazon CloudWatch Logs<a href=#amazon-cloudwatch-logs class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/cloudwatchlogs-controller rel=noopener>https://github.com/aws-controllers-k8s/cloudwatchlogs-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/cloudwatchlogs-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/cloudwatchlogs-chart</code></li></ul><h2 id=amazon-memorydb>Amazon MemoryDB<a href=#amazon-memorydb class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/memorydb-controller rel=noopener>https://github.com/aws-controllers-k8s/memorydb-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/memorydb-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/memorydb-chart</code></li></ul><h2 id=amazon-cloudwatch>Amazon CloudWatch<a href=#amazon-cloudwatch class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/cloudwatch-controller rel=noopener>https://github.com/aws-controllers-k8s/cloudwatch-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1093 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1093</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/cloudwatch-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/cloudwatch-chart</code></li></ul><h2 id=amazon-mq>Amazon MQ<a href=#amazon-mq class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/mq-controller rel=noopener>https://github.com/aws-controllers-k8s/mq-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/390 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/390</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/mq-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/mq-chart</code></li></ul><h2 id=amazon-neptune>Amazon Neptune<a href=#amazon-neptune class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1768 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1768</a></li></ul><h2 id=amazon-network-firewall>Amazon Network Firewall<a href=#amazon-network-firewall class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/networkfirewall-controller rel=noopener>https://github.com/aws-controllers-k8s/networkfirewall-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/networkfirewall-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/networkfirewall-chart</code></li></ul><h2 id=amazon-opensearch-service>Amazon OpenSearch Service<a href=#amazon-opensearch-service class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/opensearchservice-controller rel=noopener>https://github.com/aws-controllers-k8s/opensearchservice-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/opensearchservice-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/opensearchservice-chart</code></li></ul><h2 id=amazon-organizations>Amazon Organizations<a href=#amazon-organizations class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/organizations-controller rel=noopener>https://github.com/aws-controllers-k8s/organizations-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/716 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/716</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/organizations-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/organizations-chart</code></li></ul><h2 id=amazon-ram>Amazon RAM<a href=#amazon-ram class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/492 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/492</a></li></ul><h2 id=amazon-recycle-bin>Amazon Recycle Bin<a href=#amazon-recycle-bin class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1870 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1870</a></li></ul><h2 id=amazon-rds>Amazon RDS<a href=#amazon-rds class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/rds-controller rel=noopener>https://github.com/aws-controllers-k8s/rds-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/rds-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/rds-chart</code></li></ul><h2 id=amazon-route-53>Amazon Route 53<a href=#amazon-route-53 class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/route53-controller rel=noopener>https://github.com/aws-controllers-k8s/route53-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/480 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/480</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/route53-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/route53-chart</code></li></ul><h2 id=amazon-route53resolver>Amazon Route53Resolver<a href=#amazon-route53resolver class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/route53resolver-controller rel=noopener>https://github.com/aws-controllers-k8s/route53resolver-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1853 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1853</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/route53resolver-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/route53resolver-chart</code></li></ul><h2 id=amazon-s3>Amazon S3<a href=#amazon-s3 class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/s3-controller rel=noopener>https://github.com/aws-controllers-k8s/s3-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/s3-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/s3-chart</code></li></ul><h2 id=amazon-sagemaker>Amazon SageMaker<a href=#amazon-sagemaker class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/sagemaker-controller rel=noopener>https://github.com/aws-controllers-k8s/sagemaker-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/sagemaker-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/sagemaker-chart</code></li></ul><h2 id=aws-secrets-manager>AWS Secrets Manager<a href=#aws-secrets-manager class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/secretsmanager-controller rel=noopener>https://github.com/aws-controllers-k8s/secretsmanager-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>PREVIEW</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/628 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/628</a></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/secretsmanager-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/secretsmanager-chart</code></li></ul><h2 id=aws-service-catalog>AWS Service Catalog<a href=#aws-service-catalog class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/servicecatalog-controller rel=noopener>https://github.com/aws-controllers-k8s/servicecatalog-controller</a></li><li>Current project stage: <code>PLANNED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1026 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1026</a></li></ul><h2 id=amazon-sns>Amazon SNS<a href=#amazon-sns class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/sns-controller rel=noopener>https://github.com/aws-controllers-k8s/sns-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/sns-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/sns-chart</code></li></ul><h2 id=amazon-sqs>Amazon SQS<a href=#amazon-sqs class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/sqs-controller rel=noopener>https://github.com/aws-controllers-k8s/sqs-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/sqs-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/sqs-chart</code></li></ul><h2 id=amazon-ssm>Amazon SSM<a href=#amazon-ssm class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/ssm-controller rel=noopener>https://github.com/aws-controllers-k8s/ssm-controller</a></li><li>Current project stage: <code>PLANNED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/485 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/485</a></li></ul><h2 id=aws-sfn>AWS SFN<a href=#aws-sfn class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: <a href=https://github.com/aws-controllers-k8s/sfn-controller rel=noopener>https://github.com/aws-controllers-k8s/sfn-controller</a></li><li>Current project stage: <code>RELEASED</code></li><li>Current maintenance phase: <code>GENERAL AVAILABILITY</code></li><li>Container URI: <code>public.ecr.aws/aws-controllers-k8s/sfn-controller</code></li><li>Helm Chart URI: <code>public.ecr.aws/aws-controllers-k8s/sfn-chart</code></li></ul><h2 id=amazon-wafv2>Amazon WAFV2<a href=#amazon-wafv2 class=anchor aria-hidden=true>#</a></h2><ul><li>ACK service controller: None</li><li>Current project stage: <code>PROPOSED</code></li><li>Current maintenance phase: <code>NONE</code></li><li>Controller proposal: <a href=https://github.com/aws-controllers-k8s/community/issues/1300 rel=noopener>https://github.com/aws-controllers-k8s/community/issues/1300</a></li></ul><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/community/services.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/api-inference/index.html b/docs/contributor-docs/api-inference/index.html index c903ad1055..7211c79508 100644 --- a/docs/contributor-docs/api-inference/index.html +++ b/docs/contributor-docs/api-inference/index.html @@ -352,4 +352,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/api-inference.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/building-controller/index.html b/docs/contributor-docs/building-controller/index.html index 53fc7cbf1d..ce3071a77a 100644 --- a/docs/contributor-docs/building-controller/index.html +++ b/docs/contributor-docs/building-controller/index.html @@ -39,4 +39,4 @@ generated artifacts indeed are able to create an S3 bucket for us.</p><p>Learn about how to <a href=../testing>run e2e tests for an ACK controller</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/building-controller.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/code-generation/index.html b/docs/contributor-docs/code-generation/index.html index 848971d8e3..dc2021affd 100644 --- a/docs/contributor-docs/code-generation/index.html +++ b/docs/contributor-docs/code-generation/index.html @@ -65,4 +65,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/code-generation.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/code-generator-config/index.html b/docs/contributor-docs/code-generator-config/index.html index 9987266149..61b9901227 100644 --- a/docs/contributor-docs/code-generator-config/index.html +++ b/docs/contributor-docs/code-generator-config/index.html @@ -793,4 +793,4 @@ TODO</p><h2 id=attribute-based-apis>Attribute-based APIs<a href=#attribute-based-apis class=anchor aria-hidden=true>#</a></h2><p><strong>OMG TODO.</strong></p><h2 id=miscellaneousmaybe-cover-laterdocumentation-backlog>Miscellaneous/maybe cover later/documentation backlog<a href=#miscellaneousmaybe-cover-laterdocumentation-backlog class=anchor aria-hidden=true>#</a></h2><h3 id=what-does-prefixconfig-do>What does PrefixConfig do?<a href=#what-does-prefixconfig-do class=anchor aria-hidden=true>#</a></h3><h3 id=what-if-the-code-generator-cannot-figure-out-my-services-api-model-name>What if the code generator cannot figure out my service’s API model name?<a href=#what-if-the-code-generator-cannot-figure-out-my-services-api-model-name class=anchor aria-hidden=true>#</a></h3><h3 id=list_operationmatch_fields>list_operation.match_fields<a href=#list_operationmatch_fields class=anchor aria-hidden=true>#</a></h3><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/code-generator-config.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/code-organization/index.html b/docs/contributor-docs/code-organization/index.html index 0e88e36c65..63fa086167 100644 --- a/docs/contributor-docs/code-organization/index.html +++ b/docs/contributor-docs/code-organization/index.html @@ -34,4 +34,4 @@ tests for the resources exposed by that controller (<code>/test/e2e</code>).</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/code-organization.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/operatorhub-onboarding/index.html b/docs/contributor-docs/operatorhub-onboarding/index.html index 5c3622952f..03f46f5e69 100644 --- a/docs/contributor-docs/operatorhub-onboarding/index.html +++ b/docs/contributor-docs/operatorhub-onboarding/index.html @@ -32,4 +32,4 @@ merge the pull request. After these Pull Requests have been merged, the new controller is now onboarded and ready for a release.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/operatorhub-onboarding.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/overview/index.html b/docs/contributor-docs/overview/index.html index 739acebe3b..5cb5edf434 100644 --- a/docs/contributor-docs/overview/index.html +++ b/docs/contributor-docs/overview/index.html @@ -30,4 +30,4 @@ test ACK locally.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/overview.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/release/index.html b/docs/contributor-docs/release/index.html index 2b92637d03..813a6d3c39 100644 --- a/docs/contributor-docs/release/index.html +++ b/docs/contributor-docs/release/index.html @@ -55,4 +55,4 @@ Service team can see the release prowjobs, their status and logs at https://prow.ack.aws.dev/</p></li></ol><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/release.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/setup/index.html b/docs/contributor-docs/setup/index.html index 17c6d5a84e..7448048727 100644 --- a/docs/contributor-docs/setup/index.html +++ b/docs/contributor-docs/setup/index.html @@ -88,4 +88,4 @@ <a href=../building-controller>how to build an ACK service controller</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/setup.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/tenets/index.html b/docs/contributor-docs/tenets/index.html index f87e149a72..d1fde5162c 100644 --- a/docs/contributor-docs/tenets/index.html +++ b/docs/contributor-docs/tenets/index.html @@ -31,4 +31,4 @@ <code>ec2-controller</code> speaks the EC2 API.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/tenets.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/contributor-docs/testing/index.html b/docs/contributor-docs/testing/index.html index 75b2d66bb9..1d6bfce1fb 100644 --- a/docs/contributor-docs/testing/index.html +++ b/docs/contributor-docs/testing/index.html @@ -184,4 +184,4 @@ feedback.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/contributor-docs/testing.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 379f3aaa76..8c01ac3515 100644 --- a/docs/index.html +++ b/docs/index.html @@ -9,4 +9,4 @@ Discussion</button><div class="collapse collapsed" id=section-discussion><ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small"><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/background/>Background</a></li><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/faq/>FAQ</a></li><li><a class="docs-link rounded" href=https://aws-controllers-k8s.github.io/community/docs/community/discussions/>Discussions</a></li></ul></div></li></ul></nav></div><div class="col-lg-11 col-xl-9 mx-xl-auto"><article><h1 class=text-center>Docs</h1><div class=text-center></div><div class=card-list><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/adopted-resource/>Adopting Existing AWS Resources →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/api-inference/>API Inference →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/authentication/>Authentication and Credentials →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/background/>Background →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/building-controller/>Building a Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generation/>Code Generation →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-organization/>Code Organization →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/>Configure IAM Permissions →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/overview/>Contribution Overview →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/field-export/>Copy a Resource Field Into a ConfigMap or Secret →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/lambda-oci-example/>Create a Lambda OCI Function With the ACK Lambda Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/memorydb-example/>Create a Managed Amazon MemoryDB for Redis Cluster Using the ACK MemoryDB Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/resource-crud/>Create an ACK Resource →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/rds-example/>Deploy PostgreSQL, MySQL, MariaDB Instances Using the ACK RDS Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/discussions/>Discussions →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/faq/>FAQ →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/how-it-works/>How It Works →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/install/>Install an ACK Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/sagemaker-example/>Machine Learning With the ACK SageMaker Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/ec2-example/>Manage a VPC Workflow With the ACK EC2-Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/aurora-serverless-v2/>Manage an Aurora Serverless V2 Cluster With the ACK RDS Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/eventbridge-example/>Manage EventBridge Event Buses and Rules With the ACK EventBridge Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/pipes-example/>Manage EventBridge Pipes With the ACK Pipes Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/apigatewayv2-reference-example/>Manage HTTP APIs With the ACK APIGatewayv2 Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/cross-account-resource-management/>Manage Resources in Multiple AWS Accounts →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/multi-region-resource-management/>Manage Resources in Multiple Regions →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/sqs-example/>Manage SQS Queues With the ACK SQS Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/leader-election/>Managing Multiple Instances of ACK With Leader Election →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/ack-tags/>Managing Tags on Your AWS Resources →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/operatorhub-onboarding/>OperatorHub Onboarding →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Overview →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/authorization/>Permissions Overview →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/tenets/>Project Tenets →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/drift-recovery/>Recovering From Drift →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/openshift/>Red Hat OpenShift →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/release/>Release →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/releases/>Release Phases →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/deletion-policy/>Retain AWS Resources After CR Deletion →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/emr-on-eks-example/>Run Spark Jobs Using the ACK EMR on EKS Controller →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/tutorials/autoscaling-example/>Scale SageMaker Workloads With Application Auto Scaling →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/community/services/>Services →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/setup/>Setup →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/testing/>Testing →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generator-config/>Understanding Generator.yaml Configuration →</a></div></div><div class="card my-3"><div class=card-body><a class=stretched-link href=https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/>Uninstall an ACK Controller →</a></div></div></div></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/apigatewayv2-reference-example/index.html b/docs/tutorials/apigatewayv2-reference-example/index.html index 2eacc6f1a7..791cf2d1b0 100644 --- a/docs/tutorials/apigatewayv2-reference-example/index.html +++ b/docs/tutorials/apigatewayv2-reference-example/index.html @@ -156,4 +156,4 @@ </code></pre><p>To remove the APIGatewayv2 ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/apigatewayv2-reference-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/aurora-serverless-v2/index.html b/docs/tutorials/aurora-serverless-v2/index.html index 5210e84036..e907dd475d 100644 --- a/docs/tutorials/aurora-serverless-v2/index.html +++ b/docs/tutorials/aurora-serverless-v2/index.html @@ -240,4 +240,4 @@ </code></pre><p>To remove the RDS ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/aurora-serverless-v2.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/autoscaling-example/index.html b/docs/tutorials/autoscaling-example/index.html index 765422b637..bac7a8e8bd 100644 --- a/docs/tutorials/autoscaling-example/index.html +++ b/docs/tutorials/autoscaling-example/index.html @@ -210,4 +210,4 @@ </code></pre><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/autoscaling-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/ec2-example/index.html b/docs/tutorials/ec2-example/index.html index 049efeea83..df5a1d8eeb 100644 --- a/docs/tutorials/ec2-example/index.html +++ b/docs/tutorials/ec2-example/index.html @@ -320,4 +320,4 @@ </code></pre><p>To remove the EC2 ACK service controller, related CRDs, and namespaces, see <a href=https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/ec2-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/emr-on-eks-example/index.html b/docs/tutorials/emr-on-eks-example/index.html index 1e40f7df3f..b206d3bf97 100644 --- a/docs/tutorials/emr-on-eks-example/index.html +++ b/docs/tutorials/emr-on-eks-example/index.html @@ -276,4 +276,4 @@ </code></pre><ul><li>If you run into any issue, please create <a href=https://github.com/aws-controllers-k8s/community/issues>Github issue</a>. Click <strong>New issue</strong> and select the type of issue, add <code>[emr-containers] <highlevel overview></code> under title, and add enough details so that we can reproduce and provide a response</li></ul><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/emr-on-eks-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/eventbridge-example/index.html b/docs/tutorials/eventbridge-example/index.html index c41edce7ec..f01a73c8ec 100644 --- a/docs/tutorials/eventbridge-example/index.html +++ b/docs/tutorials/eventbridge-example/index.html @@ -138,4 +138,4 @@ </code></pre><p>If the command executes successfully, no output is generated.</p><p>To remove the EventBridge ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/eventbridge-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/lambda-oci-example/index.html b/docs/tutorials/lambda-oci-example/index.html index 13b4d12d38..8c2b342dc9 100644 --- a/docs/tutorials/lambda-oci-example/index.html +++ b/docs/tutorials/lambda-oci-example/index.html @@ -76,4 +76,4 @@ </code></pre><p>To remove the Lambda ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/lambda-oci-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/memorydb-example/index.html b/docs/tutorials/memorydb-example/index.html index 2276570b3c..f716efb385 100644 --- a/docs/tutorials/memorydb-example/index.html +++ b/docs/tutorials/memorydb-example/index.html @@ -271,4 +271,4 @@ </code></pre><p>To remove the MemoryDB ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/memorydb-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/pipes-example/index.html b/docs/tutorials/pipes-example/index.html index ed1ca2c2a1..073572d28f 100644 --- a/docs/tutorials/pipes-example/index.html +++ b/docs/tutorials/pipes-example/index.html @@ -186,4 +186,4 @@ </code></pre><p>If the command executes successfully, no output is generated.</p><p>To remove the Pipes ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/pipes-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/rds-example/index.html b/docs/tutorials/rds-example/index.html index 54892da8ac..c00f15e06a 100644 --- a/docs/tutorials/rds-example/index.html +++ b/docs/tutorials/rds-example/index.html @@ -219,4 +219,4 @@ </code></pre><p>To remove the RDS ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/rds-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/sagemaker-example/index.html b/docs/tutorials/sagemaker-example/index.html index 2f22e696ad..46b9a3f20c 100644 --- a/docs/tutorials/sagemaker-example/index.html +++ b/docs/tutorials/sagemaker-example/index.html @@ -192,4 +192,4 @@ </code></pre><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/sagemaker-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/tutorials/sqs-example/index.html b/docs/tutorials/sqs-example/index.html index 9a61d0c3d2..7db3240f9f 100644 --- a/docs/tutorials/sqs-example/index.html +++ b/docs/tutorials/sqs-example/index.html @@ -96,4 +96,4 @@ </code></pre><p>To remove the SQS ACK service controller, related CRDs, and namespaces, see <a href=../../user-docs/cleanup/>ACK Cleanup</a>.</p><p>To delete your EKS clusters, see <a href=https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html>Amazon EKS - Deleting a cluster</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/tutorials/sqs-example.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/ack-tags/index.html b/docs/user-docs/ack-tags/index.html index fe73077907..432c7e2a31 100644 --- a/docs/user-docs/ack-tags/index.html +++ b/docs/user-docs/ack-tags/index.html @@ -64,4 +64,4 @@ would be expanded to “k8s-name=my-ack-tagging-repo”</p></li></ul><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/ack-tags.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/adopted-resource/index.html b/docs/user-docs/adopted-resource/index.html index 85fc6543a6..f474fb6b93 100644 --- a/docs/user-docs/adopted-resource/index.html +++ b/docs/user-docs/adopted-resource/index.html @@ -81,4 +81,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/adopted-resource.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/authentication/index.html b/docs/user-docs/authentication/index.html index c3b610618e..38aded48a2 100644 --- a/docs/user-docs/authentication/index.html +++ b/docs/user-docs/authentication/index.html @@ -106,4 +106,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/authentication.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/authorization/index.html b/docs/user-docs/authorization/index.html index 63bb6c42e0..f1a16b170d 100644 --- a/docs/user-docs/authorization/index.html +++ b/docs/user-docs/authorization/index.html @@ -50,4 +50,4 @@ </code></pre><h2 id=aws-iam-permissions-for-ack-controller>AWS IAM permissions for ACK controller<a href=#aws-iam-permissions-for-ack-controller class=anchor aria-hidden=true>#</a></h2><p>The IAM role needs the correct <a href=https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html>IAM policies</a> for a given ACK service controller. For example, the ACK service controller for AWS S3 needs read and write permission for S3 Buckets. It is recommended that the IAM policy gives only enough access to properly manage the resources needed for a specific AWS service.</p><p>To use the recommended IAM policy for a given ACK service controller, refer to the <code>recommended-policy-arn</code> file in the <code>config/iam/</code> folder within that service’s public repository. This document contains the AWS Resource Name (ARN) of the recommended managed policy for a specific service. For example, the <a href=https://github.com/aws-controllers-k8s/s3-controller/tree/main/config/iam>recommended IAM policy ARN for AWS S3</a> is: <code>arn:aws:iam::aws:policy/AmazonS3FullAccess</code>.</p><p>Some services may need an additional inline policy. For example, the service controller may require <code>iam:PassRole</code> permission in order to pass an execution role that will be assumed by the AWS service. If applicable, resources for additional recommended policies will be located in the <code>recommended-inline-policy</code> file within the <code>config/iam</code> folder of a given ACK service controller’s public repository. This inline policy is applied along with the managed policies when creating the role.</p><p>If you have not yet created an IAM role, see the user documentation on how to <a href=../irsa/#create-an-iam-role-for-your-ack-service-controller>create an IAM role for your ACK service controller</a>.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/authorization.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/cleanup/index.html b/docs/user-docs/cleanup/index.html index e0c3f5221e..526d1d2a3e 100644 --- a/docs/user-docs/cleanup/index.html +++ b/docs/user-docs/cleanup/index.html @@ -26,4 +26,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/cleanup.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/cross-account-resource-management/index.html b/docs/user-docs/cross-account-resource-management/index.html index 28c0c654be..1a900a49e9 100644 --- a/docs/user-docs/cross-account-resource-management/index.html +++ b/docs/user-docs/cross-account-resource-management/index.html @@ -41,4 +41,4 @@ </code></pre><h2 id=next-steps>Next Steps<a href=#next-steps class=anchor aria-hidden=true>#</a></h2><p>Checkout the <a href=../authorization>RBAC and IAM permissions overview</a> to understand how ACK manages authorization</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/cross-account-resource-management.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/deletion-policy/index.html b/docs/user-docs/deletion-policy/index.html index d12ef5e216..0f8e75f491 100644 --- a/docs/user-docs/deletion-policy/index.html +++ b/docs/user-docs/deletion-policy/index.html @@ -45,4 +45,4 @@ prefix for a single resource.</em></p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/deletion-policy.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/drift-recovery/index.html b/docs/user-docs/drift-recovery/index.html index 088ff9e387..6a62ffe8be 100644 --- a/docs/user-docs/drift-recovery/index.html +++ b/docs/user-docs/drift-recovery/index.html @@ -44,4 +44,4 @@ </code></pre><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/drift-recovery.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/field-export/index.html b/docs/user-docs/field-export/index.html index 558f2bf427..60ed0b19a6 100644 --- a/docs/user-docs/field-export/index.html +++ b/docs/user-docs/field-export/index.html @@ -88,4 +88,4 @@ requesting it.</p></div></div><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/field-export.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/install/index.html b/docs/user-docs/install/index.html index 90182d582f..d14808dbe6 100644 --- a/docs/user-docs/install/index.html +++ b/docs/user-docs/install/index.html @@ -37,4 +37,4 @@ <a href=../authentication/>AWS credentials can be supplied</a> to the ACK controller.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/install.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/irsa/index.html b/docs/user-docs/irsa/index.html index 2a989d26ad..3f02dca834 100644 --- a/docs/user-docs/irsa/index.html +++ b/docs/user-docs/irsa/index.html @@ -104,4 +104,4 @@ validate by <a href=../resource-crud>creating a S3 bucket</a></p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/irsa.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/leader-election/index.html b/docs/user-docs/leader-election/index.html index a9f7fbaf10..91a4ef2b87 100644 --- a/docs/user-docs/leader-election/index.html +++ b/docs/user-docs/leader-election/index.html @@ -39,4 +39,4 @@ into leader election and controller behavior.</li></ul><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/leader-election.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/multi-region-resource-management/index.html b/docs/user-docs/multi-region-resource-management/index.html index a059f1e8d6..7540999e46 100644 --- a/docs/user-docs/multi-region-resource-management/index.html +++ b/docs/user-docs/multi-region-resource-management/index.html @@ -33,4 +33,4 @@ </code></pre><h2 id=next-steps>Next Steps<a href=#next-steps class=anchor aria-hidden=true>#</a></h2><p>Checkout ACK functionality for <a href=../cross-account-resource-management>creating resources in multiple AWS accounts from single controller installation.</a></p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/multi-region-resource-management.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/openshift/index.html b/docs/user-docs/openshift/index.html index c7ebc4ebb1..4311b3b7eb 100644 --- a/docs/user-docs/openshift/index.html +++ b/docs/user-docs/openshift/index.html @@ -49,4 +49,4 @@ </code></pre><h2 id=next-steps>Next Steps<a href=#next-steps class=anchor aria-hidden=true>#</a></h2><p>After you install the controller, you can follow the <a href=../cross-account-resource-management>Cross Account Resource Management</a> instructions to manage resources in multiple AWS accounts.</p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/openshift.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/docs/user-docs/resource-crud/index.html b/docs/user-docs/resource-crud/index.html index ee4f4fb994..1625c90a55 100644 --- a/docs/user-docs/resource-crud/index.html +++ b/docs/user-docs/resource-crud/index.html @@ -52,4 +52,4 @@ functionality for creating resources in multiple AWS regions.</a></p><p class=edit-page><a href=https://github.com/aws-controllers-k8s/community/blob/main/docs/content/docs/user-docs/resource-crud.md><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-edit-2"><path d="M17 3a2.828 2.828.0 114 4L7.5 20.5 2 22l1.5-5.5L17 3z"/></svg>Edit this page on GitHub</a></p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/index.html b/index.html index 31cfd3b929..33197b3549 100644 --- a/index.html +++ b/index.html @@ -4,4 +4,4 @@ <span class=toggle-dark><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-moon"><path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"/></svg></span><span class=toggle-light><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-sun"><circle cx="12" cy="12" r="5"/><line x1="12" y1="1" x2="12" y2="3"/><line x1="12" y1="21" x2="12" y2="23"/><line x1="4.22" y1="4.22" x2="5.64" y2="5.64"/><line x1="18.36" y1="18.36" x2="19.78" y2="19.78"/><line x1="1" y1="12" x2="3" y2="12"/><line x1="21" y1="12" x2="23" y2="12"/><line x1="4.22" y1="19.78" x2="5.64" y2="18.36"/><line x1="18.36" y1="5.64" x2="19.78" y2="4.22"/></svg></span></button><ul class="navbar-nav social-nav order-3 order-md-5"><li class=nav-item><a class=nav-link href=https://github.com/aws-controllers-k8s/community><svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-github"><path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37.0 00-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44.0 0020 4.77 5.07 5.07.0 0019.91 1S18.73.65 16 2.48a13.38 13.38.0 00-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07.0 005 4.77 5.44 5.44.0 003.5 8.55c0 5.42 3.3 6.61 6.44 7A3.37 3.37.0 009 18.13V22"/></svg><span class="ms-2 visually-hidden">GitHub</span></a></li></ul><div class="collapse navbar-collapse order-4 order-md-1"><ul class="navbar-nav flex-grow-1 main-nav me-auto order-5 order-md-2"><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/docs/community/overview/>Documentation</a></li><li class=nav-item><a class=nav-link href=https://aws-controllers-k8s.github.io/community/reference/>API Reference</a></li></ul><div class="break order-6 d-md-none"></div><form class="navbar-form flex-grow-1 order-7 order-md-3"><input id=userinput class="form-control is-search" type=search placeholder="Search docs..." aria-label="Search docs..." autocomplete=off><div id=suggestions class="shadow bg-white rounded"></div></form></div></div></header><div class="wrap container" role=document><div class=content><section class="section container-fluid mt-n3 pb-3"><div class="row justify-content-center"><div class="col-lg-12 text-center"><h1 class=mt-0>AWS Controllers for Kubernetes</h1></div><div class="col-lg-9 col-xl-8 text-center"><p class=lead>Manage AWS services using Kubernetes</p><a class="btn btn-primary btn-lg px-4 mb-2" href=https://aws-controllers-k8s.github.io/community/docs/community/overview/ role=button>Get started</a><p class=meta>Open-Sourced — Apache-2.0 Licensed — <a href=https://github.com/aws-controllers-k8s/community>GitHub</a></p></div></div></section></div></div><section class="section section-sm"><div class=container></div></section><section class="section section-sm container-fluid"><div class="row justify-content-center text-center"><div class=col-lg-9></div></div></section><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><div class="alert alert-primary fixed-bottom text-center" role=alert>Like ACK? <a class=alert-link href=https://github.com/aws-controllers-k8s/community/stargazers>Star us on GitHub</a>. Thanks!</a></div><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js b/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js similarity index 99% rename from index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js rename to index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js index 24ba2f6c32..79d1278ff5 100644 --- a/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js +++ b/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js @@ -1 +1 @@ -var suggestions=document.getElementById('suggestions'),userinput=document.getElementById('userinput');document.addEventListener('keydown',inputFocus);function inputFocus(a){a.keyCode===191&&(a.preventDefault(),userinput.focus()),a.keyCode===27&&(userinput.blur(),suggestions.classList.add('d-none'))}document.addEventListener('click',function(a){var b=suggestions.contains(a.target);b||suggestions.classList.add('d-none')}),document.addEventListener('keydown',suggestionFocus);function suggestionFocus(b){const d=suggestions.querySelectorAll('a'),e=[...d],a=e.indexOf(document.activeElement);let c=0;b.keyCode===38?(b.preventDefault(),c=a>0?a-1:0,d[c].focus()):b.keyCode===40&&(b.preventDefault(),c=a+1<e.length?a+1:a,d[c].focus())}(function(){var a=new FlexSearch.Document({tokenize:"forward",cache:100,document:{id:'id',store:["href","title","description"],index:["title","description","content"]}});a.add({id:0,href:"https://aws-controllers-k8s.github.io/community/docs/community/background/",title:"Background",description:"History of the ACK project",content:'\u003cp\u003eIn 10/2018 Chris Hein \u003ca href="https://aws.amazon.com/blogs/opensource/aws-service-operator-kubernetes-available/"\u003eintroduced\u003c/a\u003e the AWS Service Operator (ASO) project. We reviewed the feedback from the community and stakeholders and in 08/2019 \u003ca href="https://github.com/aws/containers-roadmap/issues/456"\u003edecided\u003c/a\u003e to relaunch ASO as a first-tier open source project with concrete commitments from the container service team. In this process, we renamed the project to AWS Controllers for Kubernetes (ACK).\u003c/p\u003e\n\u003cp\u003eThe tenets for the relaunch were:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eACK is a community-driven project, based on a governance model defining roles and responsibilities.\u003c/li\u003e\n\u003cli\u003eACK is optimized for production usage with full test coverage including performance and scalability test suites.\u003c/li\u003e\n\u003cli\u003eACK strives to be the only codebase exposing AWS services via a Kubernetes operator.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eSince then, we worked on \u003ca href="https://github.com/aws/aws-controllers-k8s/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adesign"\u003edesign issues\u003c/a\u003e and gathering feedback around which services to prioritize.\u003c/p\u003e\n\u003ch2 id="existing-custom-controllers"\u003eExisting custom controllers\u003c/h2\u003e\n\u003cp\u003eAWS service teams use custom controllers, webhooks, and operators for different use cases and based on different approaches. Examples include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-sagemaker-operator-for-k8s"\u003eSageMaker operator\u003c/a\u003e, allowing to use SageMaker from Kubernetes\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/aws-app-mesh-controller-for-k8s"\u003eApp Mesh controller\u003c/a\u003e, managing App Mesh resources from Kubernetes\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook"\u003eEKS Pod Identity Webhook\u003c/a\u003e, providing IAM roles for service accounts functionality\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eWhile the autonomy in the different teams and project allows for rapid iterations and innovations, there are some drawbacks associated with it:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe UX differs and that can lead to frustration when adopting an offering.\u003c/li\u003e\n\u003cli\u003eA consistent quality bar across the different offerings is hard to establish and to verify.\u003c/li\u003e\n\u003cli\u003eIt\u0026rsquo;s wasteful to re-invent the plumbing and necessary infrastructure (testing, etc.).\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eAbove is the motivation for our 3rd tenet: we want to make sure that there is a common framework, implementing good practices as put forward, for example, in the \u003ca href="https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/"\u003eOperator Developer Guide\u003c/a\u003e or in the \u003ca href="https://programming-kubernetes.info/"\u003eProgramming Kubernetes\u003c/a\u003e book.\u003c/p\u003e\n\u003ch2 id="related-projects"\u003eRelated projects\u003c/h2\u003e\n\u003cp\u003eOutside of AWS, there are projects that share similar goals we have with the ASO, for example:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/crossplane/provider-aws"\u003eCrossplane\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/yard-turkey/aws-s3-provisioner"\u003eaws-s3-provisioner\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:1,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/overview/",title:"Contribution Overview",description:"Context on the contributor documentation",content:'\u003cp\u003eThis section of the docs is for contributors to the AWS Controllers for\nKubernetes (ACK) project.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re interested in enhancing our platform, developing on a specific\nservice controller or just curious how ACK is architected, you\u0026rsquo;ve come to the\nright place.\u003c/p\u003e\n\u003ch2 id="project-tenets-unless-you-know-better-ones"\u003eProject Tenets (unless you know better ones)\u003c/h2\u003e\n\u003cp\u003eWe follow a set of tenets in building AWS Controllers for Kubernetes.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eCollaborate in the Open\u003c/strong\u003e: Our source code is open. Our development\nmethodology is open. Our testing, release and documentation processes are\nopen. We are a community-driven project that strives to meet our users where\nthey are.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eGenerate Everything\u003c/strong\u003e: We choose to generate as much of our code as\npossible. Generated code is easier to maintain and encourages consistency.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eFocus on Kubernetes\u003c/strong\u003e: We seek ways to make the Kubernetes user experience\nas simple and consistent as possible for managing AWS resources.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eRun Anywhere\u003c/strong\u003e: ACK service controllers can be installed on any Kubernetes\ncluster, regardless of whether a user chooses to use Amazon Elastic\nKubernetes Service (EKS).\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eMinimize Service Dependencies\u003c/strong\u003e: The only AWS services that ACK service\ncontrollers depend on should be IAM/STS and the specific AWS service that\nthe controller integrates with. We do not take a dependency on any stateful\nresource-tracking service.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eRead more about our \u003ca href="../tenets/"\u003eproject tenets and design principles\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="code-organization"\u003eCode Organization\u003c/h2\u003e\n\u003cp\u003eACK is a collection of source repositories containing a common runtime and type\nsystem, a code generator and individual service controllers that manage\nresources in a specific AWS API.\u003c/p\u003e\n\u003cp\u003eLearn more about how our \u003ca href="../code-organization/"\u003esource code repositories are organized\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="api-inference"\u003eAPI Inference\u003c/h2\u003e\n\u003cp\u003eRead about \u003ca href="../api-inference/"\u003ehow the code generator infers\u003c/a\u003e information about a\nKubernetes Custom Resource Definitions (CRDs) from an AWS API model file.\u003c/p\u003e\n\u003ch2 id="code-generation"\u003eCode Generation\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="../code-generation/"\u003ecode generation\u003c/a\u003e section gives you a bit of background\non how we go about automating the code generation for controllers and supporting\nartifacts.\u003c/p\u003e\n\u003ch2 id="setting-up-a-development-environemnt"\u003eSetting up a Development Environemnt\u003c/h2\u003e\n\u003cp\u003eIn the \u003ca href="../setup/"\u003esetup\u003c/a\u003e section we walk you through setting up your local Git\nenvironment with the repo and how advise you on how we handle contributions.\u003c/p\u003e\n\u003ch2 id="building-an-ack-service-controller"\u003eBuilding an ACK Service Controller\u003c/h2\u003e\n\u003cp\u003eAfter getting your development environment established, you will want to learn\n\u003ca href="../building-controller"\u003ehow to build an ACK service controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="testing-an-ack-service-controller"\u003eTesting an ACK Service Controller\u003c/h2\u003e\n\u003cp\u003eLast but not least, in the \u003ca href="../testing/"\u003etesting\u003c/a\u003e section we show you how to\ntest ACK locally.\u003c/p\u003e\n'}).add({id:2,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/install/",title:"Install an ACK Controller",description:"Install an ACK Controller",content:'\u003cp\u003eThe following guide will walk you through the installation of an \u003ca href="../../community/services/"\u003eACK service controller\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIndividual ACK service controllers may be in different maintenance phases and follow separate release cadences. Please check the \u003ca href="../../community/releases/#project-stages"\u003eproject stages\u003c/a\u003e and \u003ca href="../../community/releases/#maintenance-phases"\u003emaintenance phases\u003c/a\u003e of the ACK service controllers you wish to install, including how controllers are \u003ca href="../../community/releases/#releases-and-versioning"\u003ereleased and versioned\u003c/a\u003e. Controllers in a preview maintenance phase have at least one container image and Helm chart released to a public repository.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Be mindful of maintenance phases\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Check the \u003ca href="../../community/releases/#project-stages"\u003eproject stage\u003c/a\u003e and \u003ca href="../../community/releases/#maintenance-phases"\u003emaintenance phase\u003c/a\u003e of the ACK service controller you wish to install. Be aware that controllers in a preview maintenance phase may have significant and breaking changes introduced in a future release.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="install-an-ack-service-controller-with-helm-recommended"\u003eInstall an ACK service controller with Helm (Recommended)\u003c/h2\u003e\n\u003cp\u003eThe recommended way to install an ACK service controller for Kubernetes is to use \u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eEach ACK service controller has a separate Helm chart that installs the necessary supporting artifacts as a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e. This includes the ACK service controller, custom resource definitions (CRDs), and Kubernetes Role-Based Access Control (RBAC) manifests.\u003c/p\u003e\n\u003cp\u003eHelm charts for ACK service controllers can be found in the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s"\u003eACK registry within the Amazon ECR Public Gallery\u003c/a\u003e. To find a Helm chart for a specific service, you can go to \u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/$SERVICENAME-chart\u003c/code\u003e. For example, the link to the ACK service controller Helm chart for Amazon Simple Storage Service (Amazon S3) is \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-chart"\u003e\u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/s3-chart\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eHelm charts for individual ACK service controllers are tagged with their release version. You can find charts for different releases under the \u003ccode\u003eImage tags\u003c/code\u003e section in the chart repository on the ECR Public Gallery.\u003c/p\u003e\n\u003cp\u003eBefore installing a Helm chart, you can query the controller repository to find the latest release tag. This tag will correspond with a version of the Helm chart and a controller image. Then, you can use the Helm CLI to log into the ECR public Helm registry and install the chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nexport ACK_SYSTEM_NAMESPACE=ack-system\nexport AWS_REGION=us-west-2\n\naws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller \\\n oci://public.ecr.aws/aws-controllers-k8s/$SERVICE-chart --version=$RELEASE_VERSION --set=aws.region=$AWS_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Specify a release version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The commands above download the latest version of the S3 controller. To select a\ndifferent version, change the \u003ccode\u003eRELEASE_VERSION\u003c/code\u003e variable and execute the commands again.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Specify your target service region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The commands above set the target service region of the S3 controller to \u003ccode\u003eus-west-2\u003c/code\u003e. Be sure to specify your target service region in the \u003ccode\u003eAWS_REGION\u003c/code\u003e variable. This will be the \u003cem\u003edefault\u003c/em\u003e AWS region in which resources will be created by the ACK service controller. Note that a single ACK service controller can manage the lifecycle of resources in multiple AWS regions: simply add the \u003ccode\u003eservices.k8s.aws/region=$REGION\u003c/code\u003e annotation to your resource. Alternately, you can add the \u003ccode\u003eservices.k8s.aws/region=$REGION\u003c/code\u003e annotation to a Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e and any resource launched in that \u003ccode\u003eNamespace\u003c/code\u003e will be created in that region by default.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe \u003ccode\u003ehelm install\u003c/code\u003e command should return relevant installation information:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME: ack-s3-controller\nLAST DEPLOYED: Thu Jun 16 19:30:16 2022\nNAMESPACE: ack-system\nSTATUS: deployed\nREVISION: 1\nTEST SUITE: None\nNOTES: ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo verify that the Helm chart was installed, use the \u003ccode\u003ehelm list\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm list --namespace $ACK_SYSTEM_NAMESPACE -o yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003ehelm list\u003c/code\u003e command should return your newly-deployed Helm chart release information:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eapp_version: 0.1.1\nchart: s3-chart-0.1.1\nname: ack-s3-controller\nnamespace: ack-system\nrevision: \u0026quot;1\u0026quot;\nstatus: deployed\nupdated: 2022-06-16 19:30:16.260012435 +0000 UTC\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-important"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n NOTE\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The \u003ccode\u003es3-controller\u003c/code\u003e should be installed now, but it is NOT yet fully functional.\nACK controllers need access to AWS IAM credentials to manage AWS resources.\nSee \u003ca href="#Next-steps"\u003eNext Steps\u003c/a\u003e for configuring AWS IAM credentials for ACK controller.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="install-an-ack-service-controller-with-static-kubernetes-manifests"\u003eInstall an ACK service controller with static Kubernetes manifests\u003c/h2\u003e\n\u003cp\u003eIf you prefer not to use Helm, you may install an ACK service controller using static Kubernetes manifests that are included in the source repository.\u003c/p\u003e\n\u003cp\u003eStatic Kubernetes manifests install an individual service controller as a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e, including the relevant Kubernetes RBAC resources. Static Kubernetes manifests are available in the \u003ccode\u003econfig/\u003c/code\u003e directory of the associated ACK service controller\u0026rsquo;s source repository.\u003c/p\u003e\n\u003cp\u003eFor example, the static manifests needed to install the S3 service controller for ACK are available in the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/tree/main/config"\u003e\u003ccode\u003econfig/\u003c/code\u003e\u003c/a\u003e directory in the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003eS3 controller\u0026rsquo;s source repository\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="install-an-ack-service-controller-with-operatorhub-in-red-hat-openshift"\u003eInstall an ACK service controller with OperatorHub in Red Hat OpenShift\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-important"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Please reference the \u003ca href="../openshift"\u003eOpenshift\u003c/a\u003e page for necessary pre-installation steps before installing any ACK controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNavigate to the \u003cstrong\u003eCatalog -\u0026gt; OperatorHub\u003c/strong\u003e page in the OpenShift web console and then search for the ACK service controller operator you wish to install. Click \u003cstrong\u003eInstall\u003c/strong\u003e and ensure you use the \u003cstrong\u003eAll Namespaces\u003c/strong\u003e install mode, if prompted.\u003c/p\u003e\n\u003cp\u003eFor more information, see the official documentation for \u003ca href="https://docs.openshift.com/container-platform/4.9/operators/user/olm-installing-operators-in-namespace.html"\u003einstalling Operators into an OpenShift cluster\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Since authentication setup is required before installing an ACK operator into OpenShift as explained in the OpenShift pre-installation steps, you do not need to set up authentication after installation as suggested below in \u0026ldquo;Next steps.\u0026rdquo;\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eOnce you have installed your ACK service controllers, you can\n\u003ca href="../irsa/"\u003ecreate an IAM role to provide AWS access\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eAnd learn the different ways that\n\u003ca href="../authentication/"\u003eAWS credentials can be supplied\u003c/a\u003e to the ACK controller.\u003c/p\u003e\n'}).add({id:3,href:"https://aws-controllers-k8s.github.io/community/docs/community/overview/",title:"Overview",description:"AWS Controllers for Kubernetes (ACK) lets you define and use AWS service resources directly from Kubernetes",content:'\u003cp\u003e\u003cstrong\u003eAWS Controllers for Kubernetes (ACK)\u003c/strong\u003e lets you define and use AWS service resources directly from Kubernetes. With ACK, you can take advantage of AWS-managed services for your Kubernetes applications without needing to define resources outside of the cluster or run services that provide supporting capabilities like databases or message queues within the cluster.\u003c/p\u003e\n\u003ch2 id="container-images"\u003eContainer images\u003c/h2\u003e\n\u003cp\u003eEach ACK service controller is packaged into a separate container image that is published in a public repository corresponding to an individual ACK service controller.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Choose the ACK container image that is right for you\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Note that there is no single ACK container image. Instead, there are container\nimages for each individual ACK service controller that manages resources\nfor a particular AWS API.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eContainer images for ACK service controllers can be found in the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s"\u003eACK registry within the Amazon ECR Public Gallery\u003c/a\u003e. To find a container image for a specific service, you can go to \u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/$SERVICENAME-controller\u003c/code\u003e. For example, the link to the ACK service controller container image for Amazon Simple Storage Service (Amazon S3) is \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-controller"\u003e\u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIndividual ACK service controllers are tagged with their release version. You can find image URIs for different releases under the \u003ccode\u003eImage tags\u003c/code\u003e section in the image repository on the ECR Public Gallery.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Be sure to specify a release version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n You must always specify a version tag when referencing an ACK service controller image.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn accordance with \u003ca href="https://vsupalov.com/docker-latest-tag/"\u003ebest practices\u003c/a\u003e, we do not include \u003ccode\u003e:latest\u003c/code\u003e default tags for our image repositories.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThis guide assumes that you have access to a Kubernetes cluster. You do not need to use the Amazon Elastic Kubernetes Service (Amazon EKS) to get started with ACK service controllers. If you do not yet have a Kubernetes cluster and would like to use Amazon EKS, you can visit the \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e guide.\u003c/p\u003e\n\u003cp\u003eOnce you have access to a Kubernetes cluster, you can \u003ca href="../../user-docs/install/"\u003einstall the ACK service controller of your choice\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:4,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/tenets/",title:"Project Tenets",description:"Our project tenets and design principles",content:'\u003cp\u003eWe follow a set of tenets in building AWS Controllers for Kubernetes.\u003c/p\u003e\n\u003ch2 id="collaborate-in-the-open"\u003eCollaborate in the Open\u003c/h2\u003e\n\u003cp\u003eWhen given a choice between keeping something hidden or making something open,\nwe default to open.\u003c/p\u003e\n\u003cp\u003eAll of our \u003ca href="https://github.com/aws-controllers-k8s/"\u003esource code\u003c/a\u003e is open.\u003c/p\u003e\n\u003cp\u003eOur development methodology is open.\u003c/p\u003e\n\u003cp\u003eOur \u003ca href="https://github.com/aws-controllers-k8s/test-infra"\u003etesting\u003c/a\u003e, \u003ca href="../../community/releases/"\u003erelease\u003c/a\u003e and \u003ca href="https://github.com/aws-controllers-k8s/community/tree/main/docs"\u003edocumentation\u003c/a\u003e processes\nare open.\u003c/p\u003e\n\u003cp\u003eOur \u003ca href="https://prow.ack.aws.dev/"\u003econtinuous integration system\u003c/a\u003e is open.\u003c/p\u003e\n\u003cp\u003eWe are a community-driven project that strives to meet our users where they\nare. Come join our \u003ca href="https://github.com/aws-controllers-k8s/community/#community-meeting"\u003ecommunity meeting\u003c/a\u003e on Zoom.\u003c/p\u003e\n\u003ch2 id="generate-everything"\u003eGenerate Everything\u003c/h2\u003e\n\u003cp\u003eWe choose to generate as much of our code as possible.\u003c/p\u003e\n\u003cp\u003eWhile we recognize that the differences and peculiarities of AWS service APIs\nwill naturally require some implementation code to be hand-written, we look for\npatterns in AWS service APIs and enhance our code generator to handle these\npatterns.\u003c/p\u003e\n\u003cp\u003eGenerated code is easier to maintain and encourages consistency.\u003c/p\u003e\n\u003ch2 id="focus-on-kubernetes"\u003eFocus on Kubernetes\u003c/h2\u003e\n\u003cp\u003eThe ACK code generator produces controller implementations that include a\n\u003ca href="https://github.com/aws-controllers-k8s/runtime"\u003ecommon ACK runtime\u003c/a\u003e. This common runtime builds on top of the Kubernetes\nupstream \u003ca href="https://github.com/kubernetes-sigs/controller-runtime/"\u003econtroller-runtime\u003c/a\u003e framework and provides a common\nreconciliation loop that processes events received from the Kubernetes API\nserver representing create, modify or delete operations for a custom resource.\nBy building ACK controllers with a common ACK runtime, we encourage consistent\nbehaviour in how controllers handle these custom resources.\u003c/p\u003e\n\u003cp\u003eWe seek ways to make the \u003cstrong\u003eKubernetes user experience\u003c/strong\u003e as simple and\nconsistent as possible for managing AWS resources. This means that the ACK code\ngenerator enables service teams to rename fields for a resource, inject custom\ncode into a controller and instruct the controller implementation to handle\nresources in ways that smooth over the inconsistencies between AWS service\nAPIs.\u003c/p\u003e\n\u003ch2 id="run-anywhere"\u003eRun Anywhere\u003c/h2\u003e\n\u003cp\u003eACK service controllers can be installed on any Kubernetes cluster, regardless\nof whether a user chooses to use Amazon Elastic Kubernetes Service (EKS).\u003c/p\u003e\n\u003ch2 id="minimize-service-dependencies"\u003eMinimize Service Dependencies\u003c/h2\u003e\n\u003cp\u003eThe only AWS services that ACK service controllers depend on should be IAM/STS\nand the specific AWS service that the controller integrates with.\u003c/p\u003e\n\u003cp\u003eWe do not take a dependency on any stateful resource-tracking service,\nincluding AWS CloudFormation, the AWS Cloud Control API, or Terraform.\u003c/p\u003e\n\u003cp\u003eACK service controllers communicate directly with the AWS service API that the\ncontroller is built for. The \u003ccode\u003es3-controller\u003c/code\u003e speaks the S3 API. The\n\u003ccode\u003eec2-controller\u003c/code\u003e speaks the EC2 API.\u003c/p\u003e\n'}).add({id:5,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generation/",title:"Code Generation",description:"How to generate ACK controllers",content:'\u003cp\u003eIn order to keep the code for all the service controllers consistent, we will\nuse a strategy of generating the custom resource definitions and controller\ncode stubs for new AWS services.\u003c/p\u003e\n\u003ch2 id="options-considered"\u003eOptions considered\u003c/h2\u003e\n\u003cp\u003eTo generate custom resource (definitions) and controller stub code, we\ninvestigated a number of options:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ehome-grown custom code generator\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kudo.dev"\u003ekudo\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/kubernetes-sigs/kubebuilder"\u003ekubebuilder\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003ea hybrid custom code generator + \u003ccode\u003esigs.kubernetes.io/controller-tools\u003c/code\u003e (CR)\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe original AWS Service Operator used a \u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/code-generation"\u003ecustom-built generator\u003c/a\u003e that\nprocessed \u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/models"\u003eYAML manifests\u003c/a\u003e describing the AWS service and used\n\u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/code-generation/pkg/codegen/assets"\u003etemplates\u003c/a\u003e to \u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/b4befd62322a57ac78aa39ea08771fc32912592a/code-generation/pkg/codegen/assets/aws-service-operator.yaml.templ#L13-L31"\u003egenerate CRDs\u003c/a\u003e, the \u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/master/code-generation/pkg/codegen/assets/operator.go.templ"\u003econtroller code\u003c/a\u003e itself and the\n\u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/master/code-generation/pkg/codegen/assets/types.go.templ"\u003eGo types\u003c/a\u003e that represent the CRDs in memory. It\u0026rsquo;s worth noting that the\nCRDs \u003cem\u003eand\u003c/em\u003e the controller code that was generated by the original ASO was very\ntightly coupled to CloudFormation. In fact, the CRDs for individual AWS\nservices like S3 or RDS were thin wrappers around CloudFormation stacks that\ndescribed the object being operated upon.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003ekudo\u003c/code\u003e is a platform for building Kubernetes Operators. It stores state in its\nown kudo.dev CRDs and allows users to define \u0026ldquo;plans\u0026rdquo; for a deployed application\nto deploy itself. We determined that kudo was not a particularly good fit for\nASO for a couple reasons. First, we needed a way to generate CRDs in several\nAPI groups (s3.aws.com and iam.aws.com for example) and the ACK controller code\nisn\u0026rsquo;t deploying an \u0026ldquo;application\u0026rdquo; that needs to have a controlled deployment\nplan. Instead, ACK is a collection of controllers that facilitates creation and\nmanagement of various AWS service objects using Kubernetes CRD instances.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003ekubebuilder\u003c/code\u003e is the recommended upstream tool for generating CRDs and controller\nstub code. It is a Go binary that creates the scaffolding for CRDs and\ncontroller Go code. It has support for multiple API groups (e.g. \u003ccode\u003es3.amazonaws.com\u003c/code\u003e\nand \u003ccode\u003edynamodb.amazonaws.com\u003c/code\u003e) in a single code repository, so allows for sensible\nseparation of code.\u003c/p\u003e\n\u003cp\u003eOur final option was to build a hybrid custom code generator that used\ncontroller-runtime under the hood but allowed us to generate controller stub\ncode for multiple API groups and place generated code \u003ca href="https://github.com/kubernetes-sigs/kubebuilder/issues/1268"\u003ein directories\u003c/a\u003e that\nrepresented Go best practices. This option gives us the flexibility to generate\nthe files and content for multiple API groups but still stay within the\nrecommended guardrails of the upstream Kubernetes community.\u003c/p\u003e\n\u003ch2 id="our-approach"\u003eOur approach\u003c/h2\u003e\n\u003cp\u003eWe ended up with a hybrid custom+controller-runtime, using multiple phases of\ncode generation:\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/multi-phase-code-generation.png" alt="Multi-phase approach to code generation for ACK"\u003e\u003c/p\u003e\n\u003cp\u003eThe first code generation phase consumes model information from a canonical\nsource of truth about an AWS service and the objects and interfaces that\nservice exposes and generates files containing code that exposes Go types for\nthose objects. These \u0026ldquo;type files\u0026rdquo; should be annotated with the marker and\ncomments that will allow the core code generators and controller-gen to do its\nwork. We will use the \u003ca href="https://github.com/aws/aws-sdk-go/tree/master/models/apis"\u003emodel\nfiles\u003c/a\u003e from the\n\u003ca href="https://github.com/aws/aws-sdk-go"\u003e\u003ccode\u003eaws-sdk-go\u003c/code\u003e\u003c/a\u003e source repository as our\nsource of truth and use the \u003ccode\u003eaws-sdk-go/private/model/api\u003c/code\u003e Go package to\nnavigate that model.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step is the \u003ccode\u003eack-generate apis\u003c/code\u003e command.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAfter generating Kubernetes API type definitions for the top-level resources\nexposed by the AWS API, we then need to generate the \u0026ldquo;DeepCopy\u0026rdquo; interface\nimplementations that enable those top-level resources and type definitions to\nbe used by the Kubernetes runtime package (it defines an interface called\n\u003ccode\u003eruntime.Object\u003c/code\u003e that requires certain methods that copy the object and its\ncomponent parts).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen object\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, we generate the custom resource definition (CRD) configuration files, one\nfor each top-level resource identified in earlier steps.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen crd\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, we generate the actual implementation of the ACK controller for the\ntarget service. This step uses a set of templates and code in the \u003ccode\u003epkg/model\u003c/code\u003e\nGo package to construct the service-specific resource management and linkage\nwith the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client for the service. Along with these controller\nimplementation Go files, this step also outputs a set of Kubernetes\nconfiguration files for the \u003ccode\u003eDeployment\u003c/code\u003e and the \u003ccode\u003eClusterRoleBinding\u003c/code\u003e of the\n\u003ccode\u003eRole\u003c/code\u003e created in the next step.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003eack-generate controller\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eFinally, we generate the configuration file for a Kubernetes \u003ccode\u003eRole\u003c/code\u003e that the\nKubernetes \u003ccode\u003ePod\u003c/code\u003e (running in a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e) running the ACK service\ncontroller. This \u003ccode\u003eRole\u003c/code\u003e needs to have permissions to read and write CRs of the\nKind that the service controller manages.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen rbac\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="crossplane-provider-generation"\u003eCrossplane Provider Generation\u003c/h3\u003e\n\u003cp\u003eWe have experimental support for generating API types and controller code for AWS\nservices to be used in Crossplane AWS Provider. To try it out, you can run the\nfollowing command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ego run -tags codegen cmd/ack-generate/main.go crossplane ecr --provider-dir \u0026lt;directory for provider\u0026gt;\ncd \u0026lt;directory for provider\u0026gt;\ngo generate ./...\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:6,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-organization/",title:"Code Organization",description:"How the source code for ACK is organized",content:'\u003cp\u003eACK is a collection of source repositories containing a common runtime and type\nsystem, a code generator and individual service controllers that manage\nresources in a specific AWS API.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/community/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e\u003c/a\u003e: docs, issues and\nproject management (this repo)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/runtime/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/a\u003e: common ACK runtime and types\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/code-generator/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/a\u003e: the code generator and\ntemplates\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/test-infra/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/a\u003e: common test code and infrastructure\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/$SERVICE-controller\u003c/code\u003e: individual ACK\ncontrollers for AWS services.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="githubcomaws-controllers-k8scommunity-this-repo"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e (this repo)\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/community/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e\u003c/a\u003e source code\nrepository (this repo) contains the documentation that gets published to\nhttps://aws-controllers-k8s.github.io/community/.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Bug reports and feature requests\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eNOTE\u003c/strong\u003e: All [bug reports and feature requests][issues] for all ACK source repositories\nare contained in this repository.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="githubcomaws-controllers-k8sruntime"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/runtime/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/a\u003e source code repository contains\nthe common ACK controller runtime (\u003ccode\u003e/pkg/runtime\u003c/code\u003e, \u003ccode\u003e/pkg/types\u003c/code\u003e) and core\npublic Kubernetes API types (\u003ccode\u003e/apis/core\u003c/code\u003e).\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8scode-generator"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/code-generator/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/a\u003e source code repository\ncontains the \u003ccode\u003eack-generate\u003c/code\u003e CLI tool (\u003ccode\u003e/cmd/ack-generate\u003c/code\u003e), the Go packages\nthat are used in API inference and code generation (\u003ccode\u003e/pkg/generate\u003c/code\u003e,\n\u003ccode\u003e/pkg/model\u003c/code\u003e) and Bash scripts to build an ACK service controller\n(\u003ccode\u003e/scripts/build-controller.sh\u003c/code\u003e).\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8stest-infra"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/test-infra/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/a\u003e source code repository\ncontains the \u003ccode\u003eacktest\u003c/code\u003e Python package for common ACK e2e test code, the CDK to\ndeploy our Prow CI/CD system and the scripts for running tests locally.\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8sservice-controller"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/$SERVICE-controller\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eEach AWS API that has had a Kubernetes controller built to manage resources in\nthat API has its own source code repository in the\n\u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github Organization. The source repos will be\ncalled \u003ccode\u003e$SERVICE-controller\u003c/code\u003e, for example the ACK service controller for S3 is\nlocated at \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eThese service controller repositories contain Go code for the main controller\nbinary (\u003ccode\u003e/cmd/controller/\u003c/code\u003e), the public API types for the controllers\n(\u003ccode\u003e/apis\u003c/code\u003e), the Go code for the resource managers used by the controller\n(\u003ccode\u003e/pkg/resource/*/\u003c/code\u003e), static configuration manifests (\u003ccode\u003e/config\u003c/code\u003e), Helm\ncharts for the controller installation (\u003ccode\u003e/helm\u003c/code\u003e) along with a set of end-to-end\ntests for the resources exposed by that controller (\u003ccode\u003e/test/e2e\u003c/code\u003e).\u003c/p\u003e\n'}).add({id:7,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/",title:"Configure IAM Permissions",description:"Setting up ACK with IAM Roles for Service Accounts",content:'\u003cp\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Accounts\u003c/a\u003e, or IRSA, is a system that automates the\nprovisioning and rotation of IAM temporary credentials (called a Web Identity)\nthat a Kubernetes \u003ccode\u003eServiceAccount\u003c/code\u003e can use to call AWS APIs.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n TL;DR:\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eInstead of creating and distributing your AWS credentials to the containers or\nusing the Amazon EC2 instance’s role, you can associate an IAM role with a Kubernetes\nservice account. The applications in a Kubernetes pod container can then use an\nAWS SDK or the AWS CLI to make API requests to authorized AWS services.\u003c/p\u003e\n\u003cp\u003eQuicklinks:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="./#step-1-create-an-oidc-identity-provider-for-your-cluster"\u003eSetup IRSA for EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook/blob/master/SELF_HOSTED_SETUP.md"\u003eSetup IRSA for non-EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFollow the quicklink OR continue reading for more details about IRSA.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe primary advantage of IRSA is that Kubernetes \u003ccode\u003ePods\u003c/code\u003e which use the\n\u003ccode\u003eServiceAccount\u003c/code\u003e associated with an IAM Role can have a reduced IAM permission\nfootprint than the IAM Role in use for the Kubernetes EC2 worker node (known as\nthe EC2 Instance Profile Role). This security concept is known as \u003cstrong\u003eLeast\nPrivilege\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eFor example, assume you have a broadly-scoped IAM Role with permissions to\naccess the Instance Metadata Service (IMDS) from the EC2 worker node. If you do\nnot want Kubernetes \u003ccode\u003ePods\u003c/code\u003e running on that EC2 Instance to have access to IMDS,\nyou can create a different IAM Role with a reduced permission set and associate\nthis reduced-scope IAM Role with the Kubernetes \u003ccode\u003eServiceAccount\u003c/code\u003e the \u003ccode\u003ePod\u003c/code\u003e\nuses. IRSA will ensure that a special file is injected (and rotated\nperiodically) into the \u003ccode\u003ePod\u003c/code\u003e that contains a JSON Web Token (JWT) that\nencapsulates a request for temporary credentials to assume the IAM Role with\nreduced permissions.\u003c/p\u003e\n\u003cp\u003eWhen AWS clients or SDKs connect to an AWS API, they detect the existence of\nthis special token file and call the \u003ca href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html"\u003e\u003ccode\u003eSTS::AssumeRoleWithWebIdentity\u003c/code\u003e\u003c/a\u003e API\nto assume the IAM Role with reduced permissions.\u003c/p\u003e\n\u003cp\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Accounts\u003c/a\u003e (IRSA) automates the provisioning and rotation of AWS Identity and Access Management (IAM) temporary credentials that a Kubernetes service account can use to call AWS APIs.\u003c/p\u003e\n\u003cp\u003eInstead of creating and distributing your AWS credentials to the containers or using the Amazon EC2 instance’s role, you can associate an IAM role with a Kubernetes service account. The applications in a Kubernetes pod container can then use an AWS SDK or the AWS CLI to make API requests to authorized AWS services.\u003c/p\u003e\n\u003cp\u003eBy using the IRSA feature, you no longer need to provide extended permissions to the node IAM role so that pods on that node can call AWS APIs. You can scope IAM permissions to a service account, and only pods that use that service account have access to those permissions.\u003c/p\u003e\n\u003cp\u003eThe following steps demonstrate how to set up IRSA on an EKS cluster while installing the ACK S3 controller using Helm charts. By modifying the variable values as needed, these steps can be applied for the installation of other ACK service controllers.\u003c/p\u003e\n\u003ch2 id="step-1-create-an-oidc-identity-provider-for-your-cluster"\u003eStep 1. Create an OIDC identity provider for your cluster\u003c/h2\u003e\n\u003cp\u003eCreate an \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html"\u003eOpenID Connect (OIDC) identity provider\u003c/a\u003e for your EKS cluster using the \u003ccode\u003eeksctl utils\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport EKS_CLUSTER_NAME=\u0026lt;eks cluster name\u0026gt;\nexport AWS_REGION=\u0026lt;aws region id\u0026gt;\neksctl utils associate-iam-oidc-provider --cluster $EKS_CLUSTER_NAME --region $AWS_REGION --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor detailed instructions, refer to Amazon EKS documentation on how to \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html"\u003ecreate an IAM OIDC provider for your cluster\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="step-2-create-an-iam-role-and-policy-for-your-service-account"\u003eStep 2. Create an IAM role and policy for your service account\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eIf you\u0026rsquo;re trying to set up IRSA on OpenShift replace the \u003ccode\u003eOIDC_PROVIDER\u003c/code\u003e line in the bash script below with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eOIDC_PROVIDER=$(oc get authentication cluster -ojson | jq -r .spec.serviceAccountIssuer | sed -e \u0026quot;s/^https:\\/\\///\u0026quot;)\n\u003c/code\u003e\u003c/pre\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="create-an-iam-role-for-your-ack-service-controller"\u003eCreate an IAM role for your ACK service controller\u003c/h3\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the service name variables as needed\nSERVICE=\u0026quot;s3\u0026quot;\nAWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nOIDC_PROVIDER=$(aws eks describe-cluster --name $EKS_CLUSTER_NAME --region $AWS_REGION --query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | sed -e \u0026quot;s/^https:\\/\\///\u0026quot;)\nACK_K8S_NAMESPACE=ack-system\n\nACK_K8S_SERVICE_ACCOUNT_NAME=ack-$SERVICE-controller\n\nread -r -d \'\' TRUST_RELATIONSHIP \u0026lt;\u0026lt;EOF\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:oidc-provider/${OIDC_PROVIDER}\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;${OIDC_PROVIDER}:sub\u0026quot;: \u0026quot;system:serviceaccount:${ACK_K8S_NAMESPACE}:${ACK_K8S_SERVICE_ACCOUNT_NAME}\u0026quot;\n }\n }\n }\n ]\n}\nEOF\necho \u0026quot;${TRUST_RELATIONSHIP}\u0026quot; \u0026gt; trust.json\n\nACK_CONTROLLER_IAM_ROLE=\u0026quot;ack-${SERVICE}-controller\u0026quot;\nACK_CONTROLLER_IAM_ROLE_DESCRIPTION=\u0026quot;IRSA role for ACK ${SERVICE} controller deployment on EKS cluster using Helm charts\u0026quot;\naws iam create-role --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; --assume-role-policy-document file://trust.json --description \u0026quot;${ACK_CONTROLLER_IAM_ROLE_DESCRIPTION}\u0026quot;\nACK_CONTROLLER_IAM_ROLE_ARN=$(aws iam get-role --role-name=$ACK_CONTROLLER_IAM_ROLE --query Role.Arn --output text)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="attach-iam-policy-to-the-iam-role"\u003eAttach IAM policy to the IAM role\u003c/h3\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The command below will attach the ACK recommended policy to the IAM role. If you\nwish to use any other permissions, change \u003ccode\u003eIAM_POLICY_ARN\u003c/code\u003e variable\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Download the recommended managed and inline policies and apply them to the\n# newly created IRSA role\nBASE_URL=https://raw.githubusercontent.com/aws-controllers-k8s/${SERVICE}-controller/main\nPOLICY_ARN_URL=${BASE_URL}/config/iam/recommended-policy-arn\nPOLICY_ARN_STRINGS=\u0026quot;$(wget -qO- ${POLICY_ARN_URL})\u0026quot;\n\nINLINE_POLICY_URL=${BASE_URL}/config/iam/recommended-inline-policy\nINLINE_POLICY=\u0026quot;$(wget -qO- ${INLINE_POLICY_URL})\u0026quot;\n\nwhile IFS= read -r POLICY_ARN; do\n echo -n \u0026quot;Attaching $POLICY_ARN ... \u0026quot;\n aws iam attach-role-policy \\\n --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; \\\n --policy-arn \u0026quot;${POLICY_ARN}\u0026quot;\n echo \u0026quot;ok.\u0026quot;\ndone \u0026lt;\u0026lt;\u0026lt; \u0026quot;$POLICY_ARN_STRINGS\u0026quot;\n\nif [ ! -z \u0026quot;$INLINE_POLICY\u0026quot; ]; then\n echo -n \u0026quot;Putting inline policy ... \u0026quot;\n aws iam put-role-policy \\\n --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; \\\n --policy-name \u0026quot;ack-recommended-policy\u0026quot; \\\n --policy-document \u0026quot;$INLINE_POLICY\u0026quot;\n echo \u0026quot;ok.\u0026quot;\nfi\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor detailed instructions, refer to Amazon EKS documentation on \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/create-service-account-iam-policy-and-role.html"\u003ecreating an IAM role and policy for your service account\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="step-3-associate-an-iam-role-to-a-service-account-and-restart-deployment"\u003eStep 3. Associate an IAM role to a service account and restart deployment\u003c/h2\u003e\n\u003cp\u003eIf you \u003ca href="../install/"\u003einstalled your ACK service controller using a Helm chart\u003c/a\u003e, then a service account already exists on your cluster. However, it is still neccessary to associate an IAM role with the service account.\u003c/p\u003e\n\u003cp\u003eVerify that your service account exists using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe serviceaccount/$ACK_K8S_SERVICE_ACCOUNT_NAME -n $ACK_K8S_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote that the Amazon Resource Name (ARN) of the IAM role that you created is not yet set as an annotation for the service account.\u003c/p\u003e\n\u003cp\u003eUse the following commands to associate an IAM role to a service account:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Annotate the service account with the ARN\nexport IRSA_ROLE_ARN=eks.amazonaws.com/role-arn=$ACK_CONTROLLER_IAM_ROLE_ARN\nkubectl annotate serviceaccount -n $ACK_K8S_NAMESPACE $ACK_K8S_SERVICE_ACCOUNT_NAME $IRSA_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRestart ACK service controller deployment using the following commands. The restart\nwill update service controller pods with IRSA environment variables\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Note the deployment name for ACK service controller from following command\nkubectl get deployments -n $ACK_K8S_NAMESPACE\nkubectl -n $ACK_K8S_NAMESPACE rollout restart deployment \u0026lt;ACK deployment name\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-4-verify-successful-setup"\u003eStep 4: Verify successful setup\u003c/h2\u003e\n\u003cp\u003eWhen AWS clients or SDKs connect to an AWS API, they detect an \u003ca href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html"\u003eAssumeRoleWithWebIdentity\u003c/a\u003e security token to assume the IAM role.\u003c/p\u003e\n\u003cp\u003eVerify that the \u003ccode\u003eAWS_WEB_IDENTITY_TOKEN_FILE\u003c/code\u003e and \u003ccode\u003eAWS_ROLE_ARN\u003c/code\u003e environment variables exist for your Kubernetes pod using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get pods -n $ACK_K8S_NAMESPACE\nkubectl describe pod -n $ACK_K8S_NAMESPACE \u0026lt;NAME\u0026gt; | grep \u0026quot;^\\s*AWS_\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output should contain following two lines:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ROLE_ARN=arn:aws:iam::\u0026lt;AWS_ACCOUNT_ID\u0026gt;:role/\u0026lt;IAM_ROLE_NAME\u0026gt;\nAWS_WEB_IDENTITY_TOKEN_FILE=/var/run/secrets/eks.amazonaws.com/serviceaccount/token\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that ACK service controller is setup successfully with AWS permissions, let\u0026rsquo;s\nvalidate by \u003ca href="../resource-crud"\u003ecreating a S3 bucket\u003c/a\u003e\u003c/p\u003e\n'}).add({id:8,href:"https://aws-controllers-k8s.github.io/community/docs/community/faq/",title:"FAQ",description:"Frequently asked questions",content:'\u003ch2 id="service-broker"\u003eService Broker\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Does ACK replace the \u003ca href="https://svc-cat.io/"\u003eservice broker\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eFor the time being, people using the service broker should continue to use it and we\u0026rsquo;re coordinating with the maintainers to provide a unified solution.\u003c/p\u003e\n\u003cp\u003eThe service broker project is also an AWS activity that, with the general shift of focus in the community from service broker to operators, can be considered less actively developed. There are a certain things around application lifecycle management that the service broker currently covers and which are at this juncture not yet covered by the scope of ACK, however we expect in the mid to long run that these two projects converge. We had AWS-internal discussions with the team that maintains the service broker and we\u0026rsquo;re on the same page concerning a unified solution.\u003c/p\u003e\n\u003cp\u003eWe appreciate input and advice concerning features that are currently covered by the service broker only, for example bind/unbind or cataloging and looking forward to learn from the community how they are using service broker so that we can take this into account.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="cluster-api"\u003eCluster API\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Does the planned ACK service controller for EKS replace \u003ca href="https://github.com/kubernetes-sigs/cluster-api"\u003eKubernetes Cluster API\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNo, the ACK service controller for EKS does not replace Kubernetes Cluster API.\nCluster API does a lot of really cool things and is designed to be a generic way to create Kubernetes clusters that run anywhere.\nIt makes some different design decisions with that goal in mind.\nSome differences include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCluster API is treated as your source of truth for all infrastructure.\nThis means things like the cluster autoscaler need to be configured to use cluster api instead of AWS cloud provider.\u003c/li\u003e\n\u003cli\u003eGeneric Kubernetes clusters rely on running more services in the cluster and not services from AWS.\nThings like metrics and logging will likely need to run inside Kubernetes instead of using services like CloudWatch.\u003c/li\u003e\n\u003cli\u003eIAM permission for Cluster-API Provider AWS (CAPA) need to be more broad than the ACK service controller for EKS because CAPA is responsible for provisioning everything needed for the cluster (VPC, gateway, etc).\nYou don\u0026rsquo;t need to run all of the ACK controllers if all you want is a way to provision an EKS cluster.\nYou can pick and choose which ACK controllers you want to deploy.\u003c/li\u003e\n\u003cli\u003eWith the EKS ACK controller you will get all of the configuration flexibility of the EKS API including things like managed node groups and fargate.\nThis is because the ACK service controller for EKS is built directly from the EKS API spec and not abstracted to be a general Kubernetes cluster.\u003c/li\u003e\n\u003c/ul\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="cdk8s"\u003ecdk8s\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n How does ACK relate to \u003ca href="https://cdk8s.io/"\u003ecdk8s\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003ecdk8s is an open-source software development framework for defining Kubernetes applications and reusable abstractions using familiar programming languages and rich object-oriented APIs.\nYou can use cdk8s to create any resource inside a Kubernetes cluster.\nThis includes \u003ca href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/"\u003eCustom Resources\u003c/a\u003e (CRs).\u003c/p\u003e\n\u003cp\u003eAll of the ACK controllers watch for specific CRs and you can generate those resources using cdk8s or any Kubernetes tooling.\nThe two projects complement each other.\ncdk8s can create the Kubernetes resources and ACK uses those resources to create the AWS infrastructure.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="troubleshooting"\u003eTroubleshooting\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Why are my AWS resources sometimes not being fully deleted when trying to delete via \u003ccode\u003ekubectl delete ... --cascade=foreground ...\u003c/code\u003e (or via ArgoCD uninstalling my Helm chart)?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThere is a \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1759"\u003eknown issue with foreground cascading deletion\u003c/a\u003e in the ACK runtime that potentially impacts all controllers.\u003c/p\u003e\n\u003cp\u003eUntil the above issue is resolved, you should use \u003ca href="https://kubernetes.io/docs/tasks/administer-cluster/use-cascading-deletion/#use-background-cascading-deletion"\u003ebackground cascading deletion\u003c/a\u003e (the default behavior of \u003ccode\u003ekubectl\u003c/code\u003e) to delete resources.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Why am I seeing \u003ccode\u003eError: manifest does not contain minimum number of descriptors (2), descriptors found: 1\u003c/code\u003e when trying to install the Helm chart?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003ca href="https://github.com/helm/helm/releases/tag/v3.7.0"\u003eHelm 3.7\u003c/a\u003e included backward compatibility breaking changes to the manifest format of Helm charts stored in OCI chart repositories. Any images built using Helm \u0026lt;3.7 are not compatible with the latest version of the Helm CLI. This can be solved by using latest version of the chart. Use Helm version 3.7 or above with the latest version of the charts.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="contributing"\u003eContributing\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Where and how can I help?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Excellent question and we\u0026rsquo;re super excited that you\u0026rsquo;re interested in ACK.\nFor now, if you\u0026rsquo;re a developer, you can check out the \u003ca href="../../contributor-docs/overview/"\u003econtributor docs\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n'}).add({id:9,href:"https://aws-controllers-k8s.github.io/community/docs/community/how-it-works/",title:"How it Works",description:"How the ACK controller works",content:'\u003cp\u003eThe idea behind AWS Controllers for Kubernetes (ACK) is to enable Kubernetes\nusers to describe the desired state of AWS resources using the Kubernetes API\nand configuration language. In order to make this happen, let\u0026rsquo;s take a look\nunder the covers and walk through how different components in the system\ninteract.\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/ack-how-it-works.png" alt="event flow in ACK"\u003e\u003c/p\u003e\n\u003cp\u003eIn the diagram above, Alice is our Kubernetes user. Her application depends on\nthe existence of an Amazon S3 Bucket named \u003ccode\u003emy-bucket\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eInstead of creating the S3 Bucket via the AWS web console, Alice wants to only\nuse the Kubernetes API. After all, Alice uses the Kubernetes API to describe\nall her application resources \u0026ndash; a \u003ccode\u003eDeployment\u003c/code\u003e, a \u003ccode\u003eService\u003c/code\u003e, an \u003ccode\u003eIngress\u003c/code\u003e,\netc. She\u0026rsquo;d like to use the Kubernetes API to describe all the resources her\napplication requires, including this S3 Bucket.\u003c/p\u003e\n\u003cp\u003eSo, Alice issues a call to \u003ccode\u003ekubectl apply\u003c/code\u003e, passing in a file that describes a\nKubernetes \u003ca href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/"\u003ecustom resource\u003c/a\u003e describing her S3 Bucket. \u003ccode\u003ekubectl apply\u003c/code\u003e\npasses this file, called a \u003ca href="https://kubernetes.io/docs/reference/glossary/?all=true#term-manifest"\u003e\u003ccode\u003eManifest\u003c/code\u003e\u003c/a\u003e, to the Kubernetes API server\nrunning in the Kubernetes controller node. \u003ccode\u003e(1)\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eThe Kubernetes API server receives the \u003ccode\u003eManifest\u003c/code\u003e describing the S3 Bucket and\ndetermines if Alice \u003ca href="../../user-docs/authorization/"\u003ehas permissions\u003c/a\u003e to create a custom resource (CR)\nof \u003ca href="https://kubernetes.io/docs/reference/using-api/api-concepts/#standard-api-terminology"\u003e\u003ccode\u003eKind\u003c/code\u003e\u003c/a\u003e \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e, and that the custom\nresource is properly formatted \u003ccode\u003e(2)\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eIf Alice is authorized and the CR is valid, the Kubernetes API server writes\n\u003ccode\u003e(3)\u003c/code\u003e the CR to its \u003ccode\u003eetcd\u003c/code\u003e data store and then responds back \u003ccode\u003e(4)\u003c/code\u003e to Alice\nthat the CR has been created.\u003c/p\u003e\n\u003cp\u003eAt this point, the ACK service \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-controller"\u003econtroller\u003c/a\u003e for S3, which is\nrunning on a Kubernetes worker node within the context of a normal Kubernetes\n\u003ca href="https://kubernetes.io/docs/concepts/workloads/pods/"\u003e\u003ccode\u003ePod\u003c/code\u003e\u003c/a\u003e, is notified \u003ccode\u003e(5)\u003c/code\u003e that a new CR of \u003ccode\u003eKind\u003c/code\u003e\n\u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e has been created.\u003c/p\u003e\n\u003cp\u003eThe ACK service controller for S3 then communicates \u003ccode\u003e(6)\u003c/code\u003e with the AWS S3 API,\ncalling the \u003ca href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html"\u003eS3 \u003ccode\u003eCreateBucket\u003c/code\u003e API call\u003c/a\u003e to create the bucket in\nAWS. After communicating with the S3 API, the ACK service controller then calls\nthe Kubernetes API server to update \u003ccode\u003e(7)\u003c/code\u003e the CR\u0026rsquo;s \u003ca href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#object-spec-and-status"\u003e\u003ccode\u003eStatus\u003c/code\u003e\u003c/a\u003e with\ninformation it received from S3.\u003c/p\u003e\n\u003ch2 id="drift-detection-and-remediation"\u003eDrift Detection and Remediation\u003c/h2\u003e\n\u003cp\u003eThere are times where a resource that an ACK service controller is managing is\nmodified outside of ACK, e.g. through the AWS CLI or the console. An ACK service\ncontroller will look for any drift and attempt to remediate every 10 hours\n(unless a different frequency is configured). As part of the remediation, an ACK\nservice controller will reconfigure the managed resource based on the \u003ccode\u003eSpec\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eFor more information about configuring the drift remediation period, see\n\u003ca href="../../user-docs/drift-recovery"\u003eRecovering from Drift\u003c/a\u003e\u003c/p\u003e\n'}).add({id:10,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/operatorhub-onboarding/",title:"OperatorHub Onboarding",description:"How controllers end up in OperatorHub",content:'\u003cp\u003eThere are two ways a user can install an operator, one is via an OLM enabled cluster using OperatorHub.io and the other\nis via the embedded OperatorHub within an OpenShift cluster. In order to onboard a new controller and have it appear in both\nplaces, the below steps should be followed. After these steps are completed, the build/release process will then raise pull\nrequests against the proper repos.\u003c/p\u003e\n\u003ch2 id="add-an-olm-config-file-to-controller-repository"\u003eAdd an OLM Config File to Controller Repository\u003c/h2\u003e\n\u003cp\u003eThe OLM config file is used during the build/release process of a controller to assist in the generation of the\n\u003ca href="https://olm.operatorframework.io/docs/concepts/crds/clusterserviceversion/"\u003eClusterServiceVersion\u003c/a\u003e (\u0026ldquo;CSV\u0026rdquo;) in the controller\u0026rsquo;s bundle.\nThe file should live at \u003ccode\u003e./olm/olmconfig.yaml\u003c/code\u003e in the project structure of a controller. It should also contain a sample for each \u003ccode\u003eCustomResource\u003c/code\u003e\nmanaged by the controller. Please see the S3 controller\u0026rsquo;s \u003ccode\u003eolmconfig.yaml\u003c/code\u003e found\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller/blob/main/olm/olmconfig.yaml"\u003ehere\u003c/a\u003e for proper formatting.\u003c/p\u003e\n\u003ch2 id="validate-the-generated-csv"\u003eValidate the Generated CSV\u003c/h2\u003e\n\u003cp\u003eAfter the \u003ccode\u003eolmconfig.yaml\u003c/code\u003e has been generated it\u0026rsquo;s a good practice to validate that the CSV for the controller looks\nas expected, this ensures proper AWS branding for the controller. This does not need to be done after ever change to the\ncontroller, but if changes to the \u003ccode\u003eolmconfig.yaml\u003c/code\u003e are done, or a new CR is added to the controller, it\u0026rsquo;s best to validate that\nthe new changes in the CSV appears as expected.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003eBuild the controller locally using the \u003ccode\u003ecode-generator\u003c/code\u003e project\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eInstall Operator SDK in the \u003ccode\u003ecode-generator\u003c/code\u003e \u003ccode\u003e/bin\u003c/code\u003e directory using the below script\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ ./scripts/install-operator-sdk.sh\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003eTarget the appropriate controller\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ export SERVICE=s3\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003eBuild the controller and generate the bundle\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ ACK_GENERATE_OLM=true make build-controller SERVICE=$SERVICE\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eValidate that the CSV was generated\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eUnless overridden, the CSV will be at \u003ccode\u003e$GOPATH/src/github.com/aws-controllers-k8s/s3-controller/olm/bundle/manifests/ack-s3-controller.clusterserviceversion.yaml\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe CSV can be \u003ca href="https://operatorhub.io/preview"\u003epreviewed\u003c/a\u003e by copying and pasting the CSV\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/operatorhub-preview.png" alt="OperatorHub.io Preview"\u003e\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="raise-pull-requests-to-community-operators-repositories"\u003eRaise Pull Requests to Community Operators Repositories\u003c/h2\u003e\n\u003cp\u003eBoth repositories rely on the same folder structure for each operator, which is laid out below. For the initial onboarding\nall that needs to be worried about is adding \u003ccode\u003e./operators/ack-new-controller\u003c/code\u003e and the \u003ccode\u003eci.yaml\u003c/code\u003e file. Since the ACK project\nreleases all the operators using semantic versioning, each ACK operator CI file will be identical, so an existing ACK operator\u0026rsquo;s\nCI file can be copied and used in the Pull Request.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003e.\n└── ack-new-controller\n ├── 0.0.1\n ├── 0.0.2\n └── ci.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003col\u003e\n\u003cli\u003eRaise a Pull Request for OperatorHub.io \u003ca href="https://github.com/k8s-operatorhub/community-operators"\u003ehere\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eBelow is a quote from this repository\u0026rsquo;s Readme file explaining its usage\n\u003cblockquote\u003e\n\u003cp\u003eThis repo is the canonical source for Kubernetes Operators that appear on \u003ca href="https://operatorhub.io"\u003eOperatorHub.io\u003c/a\u003e.\nThe solutions merged on this repository are distributed via the \u003ca href="https://github.com/operator-framework/operator-lifecycle-manager"\u003eOLM\u003c/a\u003e index catalog \u003ca href="https://quay.io/repository/operatorhubio/catalog?tag=latest\u0026amp;tab=tags"\u003equay.io/operatorhubio/catalog\u003c/a\u003e.\nUsers can install \u003ca href="https://github.com/operator-framework/operator-lifecycle-manager"\u003eOLM\u003c/a\u003e in any Kubernetes or vendor such as Openshift to consume this content by adding a new CatalogSource for the index image\n\u003ccode\u003equay.io/operatorhubio/catalog\u003c/code\u003e. \u003ca href="https://k8s-operatorhub.github.io/community-operators/testing-operators/#1-create-the-catalogsource"\u003e(more info)\u003c/a\u003e\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="2"\u003e\n\u003cli\u003eRaise a Pull Request for embedded OperatorHub in OpenShift \u003ca href="https://github.com/redhat-openshift-ecosystem/community-operators-prod"\u003ehere\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eBelow is a quote from this repository\u0026rsquo;s Readme file explaining its usage\n\u003cblockquote\u003e\n\u003cp\u003eThis repo is the canonical source for Kubernetes Operators that appear on \u003ca href="https://openshift.com"\u003eOpenShift Container Platform\u003c/a\u003e\nand \u003ca href="https://www.okd.io/"\u003eOKD\u003c/a\u003e.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe build for these Pull Requests will fail since no bundle has been provided, but that is okay, the maintainers will still review and\nmerge the pull request. After these Pull Requests have been merged, the new controller is now onboarded and ready for a release.\u003c/p\u003e\n'}).add({id:11,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/api-inference/",title:"API Inference",description:"How ACK introspects an AWS API model file",content:'\u003cp\u003eThis document discusses how ACK introspects an AWS API model file and\ndetermines which \u003ccode\u003eCustomResourceDefinition\u003c/code\u003es (CRDs) to construct and what the\nstructure of those CRDs look like.\u003c/p\u003e\n\u003ch2 id="the-kubernetes-resource-model"\u003eThe Kubernetes Resource Model\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/"\u003eKubernetes Resource Model\u003c/a\u003e (KRM) is a set of \u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md"\u003estandards\u003c/a\u003e\nand naming conventions that govern how an \u003ca href="https://kubernetes.io/docs/reference/glossary/?all=true#term-object"\u003e\u003ccode\u003eObject\u003c/code\u003e\u003c/a\u003e may be created and\nupdated.\u003c/p\u003e\n\u003cp\u003eAn \u003ccode\u003eObject\u003c/code\u003e includes some metadata about the object \u0026ndash; a\n\u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#resources"\u003e\u003ccode\u003eGroupVersionKind\u003c/code\u003e\u003c/a\u003e (GVK), a \u003ccode\u003eName\u003c/code\u003e, a \u003ccode\u003eNamespace\u003c/code\u003e, and zero or more \u003ccode\u003eLabels\u003c/code\u003e\nand \u003ccode\u003eAnnotations\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eIn addition to this metadata, each \u003ccode\u003eObject\u003c/code\u003e has a \u003ccode\u003eSpec\u003c/code\u003e field which is a\nstruct that contains the \u003cstrong\u003edesired\u003c/strong\u003e state of the \u003ccode\u003eObject\u003c/code\u003e. \u003ccode\u003eObjects\u003c/code\u003e are\ntypically denoted using YAML, like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-amazing-bucket\n annotations:\n pronounced-as: boo-kay\nspec:\n name: my-amazing-bucket\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Manifests\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The YAML files containing an object definition like above are typically\ncalled \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-manifest"\u003e\u003cstrong\u003emanifests\u003c/strong\u003e\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAbove, the \u003ccode\u003eObject\u003c/code\u003e has a GVK of \u0026ldquo;s3.services.k8s.aws/v1alpha1:Bucket\u0026rdquo; with an\n\u003cstrong\u003einternal-to-Kubernetes\u003c/strong\u003e \u003ccode\u003eName\u003c/code\u003e of \u0026ldquo;my-amazing-bucket\u0026rdquo; and a single\n\u003ccode\u003eAnnotation\u003c/code\u003e key/value pair \u0026ldquo;pronounced-as: boo-kay\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eSpec\u003c/code\u003e field is a structure containing desired state fields about this\nBucket. You can see here that there is a \u003ccode\u003eSpec.Name\u003c/code\u003e field representing the\nBucket name that will be passed to the S3 CreateBucket API as the name of the\nBucket. Note that the \u003ccode\u003eMetadata.Name\u003c/code\u003e field value is the same as the\n\u003ccode\u003eSpec.Name\u003c/code\u003e field value here, but there\u0026rsquo;s nothing mandatory about this.\u003c/p\u003e\n\u003cp\u003eWhen a Kubernetes user creates an \u003ccode\u003eObject\u003c/code\u003e, typically by passing some YAML to\nthe \u003ccode\u003ekubectl create\u003c/code\u003e or \u003ccode\u003ekubectl apply\u003c/code\u003e CLI command, the Kubernetes API server\nreads the manifest and determines whether the supplied contents are valid.\u003c/p\u003e\n\u003cp\u003eIn order to determine if a manifest is valid, the Kubernetes API server must\nlook up the \u003cstrong\u003edefinition\u003c/strong\u003e of the specified \u003ccode\u003eGroupVersionKind\u003c/code\u003e. For all of the\nresources that ACK is concerned about, what this means is that the Kubernetes\nAPI server will search for the \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-CustomResourceDefinition"\u003e\u003ccode\u003eCustomResourceDefinition\u003c/code\u003e\u003c/a\u003e (CRD) matching\nthe \u003ccode\u003eGroupVersionKind\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThis CRD describes the fields that comprise \u003ccode\u003eObject\u003c/code\u003es of that particular\n\u003ccode\u003eGroupVersionKind\u003c/code\u003e \u0026ndash; called \u003ccode\u003eCustomResources\u003c/code\u003e (CRs).\u003c/p\u003e\n\u003cp\u003eIn the next sections we discuss:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ehow ACK determines what will become a CRD\u003c/li\u003e\n\u003cli\u003ehow ACK determines the fields that go into each CRD\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="which-things-become-ack-resources"\u003eWhich things become ACK Resources?\u003c/h2\u003e\n\u003cp\u003eAs mentioned in the \u003ca href="../code-generation/"\u003ecode generation documentation\u003c/a\u003e, ACK reads AWS API\nmodel files when generating its API types and controller implementations. These\nmodel files are JSON files contain some important information about the\nstructure of the AWS service API, including a set of \u003cem\u003eOperation\u003c/em\u003e definitions\n(commonly called \u0026ldquo;Actions\u0026rdquo; in the official AWS API documentation) and a set of\n\u003cem\u003eShape\u003c/em\u003e definitions.\u003c/p\u003e\n\u003cp\u003eSome AWS APIs have dozens (hundreds even!) of Operations exposed by the API.\nConsider EC2\u0026rsquo;s API. It has over \u003cstrong\u003e400 separate Actions\u003c/strong\u003e. Out of all those\nOperations, how are we to tell which ones refer to something that we can model\nas a Kubernetes \u003ccode\u003eCustomResource\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, we could look at the EC2 API\u0026rsquo;s list of Operations and manually decide\nwhich ones seem \u0026ldquo;resource-y\u0026rdquo;. Operations like \u0026ldquo;AdvertiseByoipCidr\u0026rdquo; and\n\u0026ldquo;AcceptTransitGatewayVpcAttachment\u0026rdquo; don\u0026rsquo;t seem very \u0026ldquo;resource-y\u0026rdquo;. Operations\nlike \u0026ldquo;CreateKeyPair\u0026rdquo; and \u0026ldquo;DeleteKeyPair\u0026rdquo;, however, do seem like they would\nmatch a resource called \u0026ldquo;KeyPair\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eAnd this is actually how ACK decides what is a \u003ccode\u003eCustomResource\u003c/code\u003e and what isn\u0026rsquo;t.\u003c/p\u003e\n\u003cp\u003eIt uses a simple heuristic: \u003cem\u003elook through the list of Operations in the API\nmodel file and filter out the ones that start with the string \u0026ldquo;Create\u0026rdquo;. If what\ncomes after the word \u0026ldquo;Create\u0026rdquo; describes a singular noun, then we create a\n\u003ccode\u003eCustomResource\u003c/code\u003e of that \u003ccode\u003eKind\u003c/code\u003e\u003c/em\u003e.\u003c/p\u003e\n\u003cp\u003eIt really is that simple.\u003c/p\u003e\n\u003ch2 id="how-is-an-ack-resource-defined"\u003eHow is an ACK Resource Defined?\u003c/h2\u003e\n\u003cp\u003eLet\u0026rsquo;s take a look at the \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/df6183acdc5b9b8508ea2fc8ec8c39fd19301ac6/services/s3/config/crd/bases/s3.services.k8s.aws_buckets.yaml"\u003eCRD for ACK\u0026rsquo;s S3 Bucket\u003c/a\u003e (the\n\u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e \u003ccode\u003eGroupKind\u003c/code\u003e (GK)) (snipped slightly for brevity):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e---\napiVersion: apiextensions.k8s.io/v1\nkind: CustomResourceDefinition\nmetadata:\n name: buckets.s3.services.k8s.aws\nspec:\n group: s3.services.k8s.aws\n names:\n kind: Bucket\n scope: Namespaced\n versions:\n - name: v1alpha1\n schema:\n openAPIV3Schema:\n description: Bucket is the Schema for the Buckets API\n properties:\n apiVersion:\n type: string\n kind:\n type: string\n metadata:\n type: object\n spec:\n description: BucketSpec defines the desired state of Bucket\n properties:\n acl:\n type: string\n createBucketConfiguration:\n properties:\n locationConstraint:\n type: string\n type: object\n grantFullControl:\n type: string\n grantRead:\n type: string\n grantReadACP:\n type: string\n grantWrite:\n type: string\n grantWriteACP:\n type: string\n name:\n type: string\n objectLockEnabledForBucket:\n type: boolean\n required:\n - name\n type: object\n status:\n description: BucketStatus defines the observed state of Bucket\n properties:\n ackResourceMetadata:\n properties:\n arn:\n type: string\n ownerAccountID:\n type: string\n required:\n - ownerAccountID\n type: object\n conditions:\n items:\n properties:\n lastTransitionTime:\n format: date-time\n type: string\n message:\n type: string\n reason:\n type: string\n status:\n type: string\n type:\n type: string\n required:\n - status\n - type\n type: object\n type: array\n location:\n type: string\n required:\n - ackResourceMetadata\n - conditions\n type: object\n type: object\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe above YAML representation of a \u003ccode\u003eCustomResourceDefinition\u003c/code\u003e (CRD) is actually\ngenerated from a set of Go type definitions. These Go type definitions live in\neach ACK service\u0026rsquo;s \u003ccode\u003eservices/$SERVICE/apis/$VERSION\u003c/code\u003e directory.\u003c/p\u003e\n\u003cp\u003eThis section of our documentation discusses how we create those Go type\ndefinitions.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n controller-gen crd\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The OpenAPIv3 Validating Schema shown above is created by the\n[\u003ccode\u003econtroller-gen crd\u003c/code\u003e][cg] CLI command and is a convenient human-readable\nrepresentation of the \u003ccode\u003eCustomResourceDefinition\u003c/code\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe Bucket CR\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e field is defined above as containing a set of fields \u0026ndash;\n\u0026ldquo;acl\u0026rdquo;, \u0026ldquo;createBucketConfiguration\u0026rdquo;, \u0026ldquo;name\u0026rdquo;, etc. Each field has a JSONSchema\ntype that corresponds with the Go type from the associated field member.\u003c/p\u003e\n\u003cp\u003eYou will also notice that in addition to the definition of a \u003ccode\u003eSpec\u003c/code\u003e field,\nthere is also the definition of a \u003ccode\u003eStatus\u003c/code\u003e field for the Bucket CRs. Above,\nthis \u003ccode\u003eStatus\u003c/code\u003e contains fields that represent the \u0026ldquo;observed\u0026rdquo; state of the Bucket\nCRs. The above shows three fields in the Bucket\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e:\n\u003ccode\u003eackResourceMetadata\u003c/code\u003e, \u003ccode\u003econditions\u003c/code\u003e and \u003ccode\u003elocation\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eYou might be wondering how the ACK code generator determined which fields go\ninto the Bucket\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and which fields go into the Bucket\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, it\u0026rsquo;s definitely not a manual process. Everything in ACK is code-generated\nand discovered by inspecting the AWS API model files.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n What are AWS API model files?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The AWS API model files are JSON files that contain information about a\nparticular AWS service API\u0026rsquo;s Actions and Shapes. We consume the model files\n[distributed][aws-sdk-go-model-files] in the \u003ccode\u003eaws-sdk-go\u003c/code\u003e project. (Look\nfor the \u003ccode\u003eapi-2.json\u003c/code\u003e files in the linked service-specific directories\u0026hellip;)\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eLet\u0026rsquo;s take a look at a tiny bit of the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/testdata/models/apis/s3/0000-00-00/api-2.json"\u003eAWS S3 API model file\u003c/a\u003e and\nyou can start to see how we identify the things that go into the \u003ccode\u003eSpec\u003c/code\u003e and\n\u003ccode\u003eStatus\u003c/code\u003e fields.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e{\n \u0026quot;metadata\u0026quot;:{\n \u0026quot;serviceId\u0026quot;:\u0026quot;S3\u0026quot;,\n },\n \u0026quot;operations\u0026quot;:{\n \u0026quot;CreateBucket\u0026quot;:{\n \u0026quot;name\u0026quot;:\u0026quot;CreateBucket\u0026quot;,\n \u0026quot;http\u0026quot;:{\n \u0026quot;method\u0026quot;:\u0026quot;PUT\u0026quot;,\n \u0026quot;requestUri\u0026quot;:\u0026quot;/{Bucket}\u0026quot;\n },\n \u0026quot;input\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;CreateBucketRequest\u0026quot;},\n \u0026quot;output\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;CreateBucketOutput\u0026quot;},\n },\n },\n \u0026quot;shapes\u0026quot;:{\n \u0026quot;BucketCannedACL\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;string\u0026quot;,\n \u0026quot;enum\u0026quot;:[\n \u0026quot;private\u0026quot;,\n \u0026quot;public-read\u0026quot;,\n \u0026quot;public-read-write\u0026quot;,\n \u0026quot;authenticated-read\u0026quot;\n ]\n },\n \u0026quot;BucketName\u0026quot;:{\u0026quot;type\u0026quot;:\u0026quot;string\u0026quot;},\n \u0026quot;CreateBucketConfiguration\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;LocationConstraint\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;BucketLocationConstraint\u0026quot;}\n }\n },\n \u0026quot;CreateBucketOutput\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;Location\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;Location\u0026quot;,\n }\n }\n },\n \u0026quot;CreateBucketRequest\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;required\u0026quot;:[\u0026quot;Bucket\u0026quot;],\n \u0026quot;members\u0026quot;:{\n \u0026quot;ACL\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;BucketCannedACL\u0026quot;,\n },\n \u0026quot;Bucket\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;BucketName\u0026quot;,\n },\n \u0026quot;CreateBucketConfiguration\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;CreateBucketConfiguration\u0026quot;,\n },\n \u0026quot;GrantFullControl\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantFullControl\u0026quot;,\n },\n \u0026quot;GrantRead\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantRead\u0026quot;,\n },\n \u0026quot;GrantReadACP\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantReadACP\u0026quot;,\n },\n \u0026quot;GrantWrite\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantWrite\u0026quot;,\n },\n \u0026quot;GrantWriteACP\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantWriteACP\u0026quot;,\n },\n \u0026quot;ObjectLockEnabledForBucket\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;ObjectLockEnabledForBucket\u0026quot;,\n }\n },\n },\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs mentioned above, we determine what things in an API are\n\u003ccode\u003eCustomResourceDefinition\u003c/code\u003es by looking for \u003ccode\u003eOperation\u003c/code\u003es that begin with the\nstring \u0026ldquo;Create\u0026rdquo; and where the remainder of the \u003ccode\u003eOperation\u003c/code\u003e name refers to a\n\u003cem\u003esingular\u003c/em\u003e noun.\u003c/p\u003e\n\u003cp\u003eFor the S3 API, there happens to be only a single Operation that begins with\nthe string \u0026ldquo;Create\u0026rdquo;, and it happens to be \u0026ldquo;\u003ca href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html"\u003eCreateBucket\u003c/a\u003e\u0026rdquo;.\nAnd since \u0026ldquo;Bucket\u0026rdquo; refers to a singular noun, that is the\n\u003ccode\u003eCustomResourceDefinition\u003c/code\u003e that is identified by the ACK code generator.\u003c/p\u003e\n\u003cp\u003eThe ACK code generator writes a file \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go"\u003e\u003ccode\u003eapis/v1alpha1/bucket.go\u003c/code\u003e\u003c/a\u003e\nthat contains a \u003ccode\u003eBucketSpec\u003c/code\u003e struct definition, a \u003ccode\u003eBucketStatus\u003c/code\u003e struct\ndefinition and a \u003ccode\u003eBucket\u003c/code\u003e struct definition that ties the Spec and Status\ntogether into our CRD.\u003c/p\u003e\n\u003cp\u003eIn determining the structure of the \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e CRD, the ACK\ncode generator inspects the \u003ccode\u003eShape\u003c/code\u003es referred to by the \u0026ldquo;input\u0026rdquo; and \u0026ldquo;output\u0026rdquo;\nmembers of the \u0026ldquo;CreateBucket\u0026rdquo; \u003ccode\u003eOperation\u003c/code\u003e: \u0026ldquo;CreateBucketRequest\u0026rdquo; and\n\u0026ldquo;CreateBucketOutput\u0026rdquo; respectively.\u003c/p\u003e\n\u003ch3 id="determining-the-spec-fields"\u003eDetermining the Spec fields\u003c/h3\u003e\n\u003cp\u003eFor the \u003ccode\u003eBucketSpec\u003c/code\u003e fields, we grab members of the \u003ccode\u003eInput\u003c/code\u003e shape. The\n\u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go#L23-L35"\u003egenerated Go type definition\u003c/a\u003e for the \u003ccode\u003eBucketSpec\u003c/code\u003e ends up looking\nlike this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e// BucketSpec defines the desired state of Bucket\ntype BucketSpec struct {\n ACL *string `json:\u0026quot;acl,omitempty\u0026quot;`\n CreateBucketConfiguration *CreateBucketConfiguration `json:\u0026quot;createBucketConfiguration,omitempty\u0026quot;`\n GrantFullControl *string `json:\u0026quot;grantFullControl,omitempty\u0026quot;`\n GrantRead *string `json:\u0026quot;grantRead,omitempty\u0026quot;`\n GrantReadACP *string `json:\u0026quot;grantReadACP,omitempty\u0026quot;`\n GrantWrite *string `json:\u0026quot;grantWrite,omitempty\u0026quot;`\n GrantWriteACP *string `json:\u0026quot;grantWriteACP,omitempty\u0026quot;`\n // +kubebuilder:validation:Required\n Name *string `json:\u0026quot;name\u0026quot;`\n ObjectLockEnabledForBucket *bool `json:\u0026quot;objectLockEnabledForBucket,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s take a closer look at the \u003ccode\u003eBucketSpec\u003c/code\u003e fields.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eACL\u003c/code\u003e, \u003ccode\u003eGrantFullControl\u003c/code\u003e, \u003ccode\u003eGrantRead\u003c/code\u003e, \u003ccode\u003eGrantReadACP\u003c/code\u003e, \u003ccode\u003eGrantWrite\u003c/code\u003e and\n\u003ccode\u003eGrantWriteACP\u003c/code\u003e fields are simple \u003ccode\u003e*string\u003c/code\u003e types. However, if we look at the\n\u003ccode\u003eCreateBucketRequest\u003c/code\u003e Shape definition in the API model file, we see that these\nfields actually are differently-named Shapes, not \u003ccode\u003e*string\u003c/code\u003e. Why is this? Well,\nthe ACK code generator \u0026ldquo;flattens\u0026rdquo; some Shapes when it notices that a named\nShape is just an alias for a simple scalar type (like \u003ccode\u003e*string\u003c/code\u003e).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Why \u003ccode\u003e*string\u003c/code\u003e?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The astute reader may be wondering why the Go type for string fields is\n\u003ccode\u003e*string\u003c/code\u003e and not \u003ccode\u003estring\u003c/code\u003e. The reason for this lies in \u003ccode\u003eaws-sdk-go\u003c/code\u003e. All\ntypes for all Shape members are pointer types, even when the underlying\ndata type is a simple scalar type like \u003ccode\u003ebool\u003c/code\u003e or \u003ccode\u003eint\u003c/code\u003e. Yes, even when\nthe field is required\u0026hellip;\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNote that even though the \u003ccode\u003eACL\u003c/code\u003e field has a Shape of \u003ccode\u003eBucketCannedACL\u003c/code\u003e, that\nShape is actually just a \u003ccode\u003estring\u003c/code\u003e with a set of enumerated values. Enumerated\nvalues are collected and written out by the ACK code generator into an\n\u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/enums.go"\u003e\u003ccode\u003eapis/v1alpha1/enums.go\u003c/code\u003e\u003c/a\u003e file, with content like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003etype BucketCannedACL string\n\nconst (\n BucketCannedACL_private BucketCannedACL = \u0026quot;private\u0026quot;\n BucketCannedACL_public_read BucketCannedACL = \u0026quot;public-read\u0026quot;\n BucketCannedACL_public_read_write BucketCannedACL = \u0026quot;public-read-write\u0026quot;\n BucketCannedACL_authenticated_read BucketCannedACL = \u0026quot;authenticated-read\u0026quot;\n)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003eCreateBucketConfiguration\u003c/code\u003e field is of type \u003ccode\u003e*CreateBucketConfiguration\u003c/code\u003e.\nAll this means is that the field refers to a nested struct. All struct type\ndefinitions for CRD Spec or Status field members are placed by the ACK code\ngenerator into a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/types.go"\u003e\u003ccode\u003eapis/v1alpha1/types.go\u003c/code\u003e\u003c/a\u003e file.\u003c/p\u003e\n\u003cp\u003eHere is a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/types.go#L36-L38"\u003esnippet\u003c/a\u003e of that file that contains the type definition for\nthe \u003ccode\u003eCreateBucketConfiguration\u003c/code\u003e struct:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003etype CreateBucketConfiguration struct {\n LocationConstraint *string `json:\u0026quot;locationConstraint,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow, the \u003ccode\u003eName\u003c/code\u003e field in the \u003ccode\u003eBucketSpec\u003c/code\u003e struct seems out of place, no? There\nis no \u0026ldquo;Name\u0026rdquo; member of the \u003ccode\u003eCreateBucketRequest\u003c/code\u003e Shape, so why is there a\n\u003ccode\u003eName\u003c/code\u003e field in \u003ccode\u003eBucketSpec\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, this is an example of ACK\u0026rsquo;s code generator using some special\ninstructions contained in something called the \u003ccode\u003egenerator.yaml\u003c/code\u003e (or \u0026ldquo;generator\nconfig\u0026rdquo;) for the S3 service controller.\u003c/p\u003e\n\u003cp\u003eEach service in the \u003ccode\u003eservices/\u003c/code\u003e directory can have a \u003ccode\u003egenerator.yaml\u003c/code\u003e file that\ncontains overrides and special instructions for how to interpret and transform\nparts of the service\u0026rsquo;s API.\u003c/p\u003e\n\u003cp\u003eHere is part of the \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/generator.yaml"\u003eS3 service\u0026rsquo;s \u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Bucket:\n renames:\n operations:\n CreateBucket:\n input_fields:\n Bucket: Name\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, the generator config for the ACK S3 service controller is\nrenaming the \u003ccode\u003eCreateBucket\u003c/code\u003e Operation\u0026rsquo;s Input Shape \u003ccode\u003eBucket\u003c/code\u003e field to \u003ccode\u003eName\u003c/code\u003e.\nWe do this for some APIs to add a little consistency and a more\nKubernetes-native experience for the CRDs. In Kubernetes, there is a\n\u003ccode\u003eMetadata.Name\u003c/code\u003e (internal Kubernetes name) and there is typically a \u003ccode\u003eSpec.Name\u003c/code\u003e\nfield which refers to the \u003cstrong\u003eexternal\u003c/strong\u003e Name of the resource. So, in order to\nalign the \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e\u0026rsquo;s definition to be more Kubernetes-like,\nwe rename the \u003ccode\u003eBucket\u003c/code\u003e field to \u003ccode\u003eName\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eWe do this renaming for other things that produce a bit of a\n\u0026ldquo;\u003ca href="https://github.com/aws/aws-sdk-go/blob/master/private/model/api/legacy_stutter.go"\u003estutter\u003c/a\u003e\u0026rdquo;, as well as where the name of a field does not conform to\nGo exported name constraints or \u003ca href="https://golang.org/doc/effective_go.html#names"\u003enaming best practices\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="determining-the-status-fields"\u003eDetermining the Status fields\u003c/h3\u003e\n\u003cp\u003eRemember that fields in a CR\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct are not mutable by normal\nKubernetes users. Instead, these fields represent the latest observed state of\na resource (instead of the \u003cem\u003edesired\u003c/em\u003e state of that resource which is\nrepresented by fields in the CR\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e struct).\u003c/p\u003e\n\u003cp\u003eThe ACK code generator takes the members of the Create \u003ccode\u003eOperation\u003c/code\u003e\u0026rsquo;s \u003ccode\u003eOutput\u003c/code\u003e\nshape and puts those fields into the CR\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct.\u003c/p\u003e\n\u003cp\u003eWe assume that fields in the \u003ccode\u003eOutput\u003c/code\u003e that have the same name as fields in the\n\u003ccode\u003eInput\u003c/code\u003e shape for the Create \u003ccode\u003eOperation\u003c/code\u003e refer to the resource field that was\nset in the \u003ccode\u003eSpec\u003c/code\u003e field and therefore \u003cstrong\u003eare only interested in fields in the\n\u003ccode\u003eOutput\u003c/code\u003e that are not in the \u003ccode\u003eInput\u003c/code\u003e\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eLooking at the \u003ccode\u003eBucketSpec\u003c/code\u003e struct definition that was generated after\nprocessing the S3 API model file, we find \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go#L37-L49"\u003ethis\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e// BucketStatus defines the observed state of Bucket\ntype BucketStatus struct {\n // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member\n // that is used to contain resource sync state, account ownership,\n // constructed ARN for the resource\n ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:\u0026quot;ackResourceMetadata\u0026quot;`\n // All CRS managed by ACK have a common `Status.Conditions` member that\n // contains a collection of `ackv1alpha1.Condition` objects that describe\n // the various terminal states of the CR and its backend AWS service API\n // resource\n Conditions []*ackv1alpha1.Condition `json:\u0026quot;conditions\u0026quot;`\n Location *string `json:\u0026quot;location,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s discuss each of the fields shown above.\u003c/p\u003e\n\u003cp\u003eFirst, the \u003ccode\u003eACKResourceMetadata\u003c/code\u003e field is included in \u003cstrong\u003eevery ACK CRD\u0026rsquo;s Status\nfield\u003c/strong\u003e. It is a pointer to a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/apis/core/v1alpha1/resource_metadata.go#L16-L33"\u003e\u003ccode\u003eackv1alpha1.ResourceMetadata\u003c/code\u003e\u003c/a\u003e struct.\nThis struct contains some standard and important pieces of information about\nthe resource, including the AWS Resource Name (ARN) and the Owner AWS Account\nID.\u003c/p\u003e\n\u003cp\u003eThe ARN is a globally-unique identifier for the resource in AWS. The Owner AWS\nAccount ID is the 12-digit AWS account ID that is billed for the resource.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Cross-account resource management\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The Owner AWS Account ID for a resource \u003ca href="../../user-docs/authorization/#create-resource-in-different-aws-accounts"\u003emay be different\u003c/a\u003e from the\nAWS Account ID of the IAM Role that the ACK service controller is executing\nunder.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe \u003ccode\u003eConditions\u003c/code\u003e field is also included in every ACK CRD\u0026rsquo;s Status field. It is\na slice of pointers to \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/apis/core/v1alpha1/conditions.go#L37-L54"\u003e\u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e\u003c/a\u003e structs. The\n\u003ccode\u003eCondition\u003c/code\u003e struct is responsible for conveying information about the latest\nobserved sync state of a resource, including any terminal condition states that\ncause the resource to be \u0026ldquo;unsyncable\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eNext is the \u003ccode\u003eLocation\u003c/code\u003e field. This field gets its definition from the S3\n\u003ccode\u003eCreateBucketOutput.Location\u003c/code\u003e field:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e \u0026quot;CreateBucketOutput\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;Location\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;Location\u0026quot;,\n }\n }\n },\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:12,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/resource-crud/",title:"Create an ACK Resource",description:"Create, Update and Delete an S3 bucket",content:'\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eWhile this guide provides examples for managing S3 bucket, you can find sample\nmanifest files for other AWS services in \u003ccode\u003etest/e2e/resources\u003c/code\u003e directory of\ncorresponding service controller\u0026rsquo;s GitHub repository. For example: Sample manifest\nfor ecr repository can be found \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/tree/main/test/e2e/resources"\u003ehere\u003c/a\u003e\u003c/p\u003e\n\u003cp\u003eYou can find API Reference for all the services supported by ACK \u003ca href="../../../reference"\u003ehere\u003c/a\u003e\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="create-an-s3-bucket"\u003eCreate an S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport BUCKET_NAME=my-ack-s3-bucket-$AWS_ACCOUNT_ID\n\nread -r -d \'\' BUCKET_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: $BUCKET_NAME\nspec:\n name: $BUCKET_NAME\nEOF\n\necho \u0026quot;${BUCKET_MANIFEST}\u0026quot; \u0026gt; bucket.yaml\n\nkubectl create -f bucket.yaml\n\nkubectl describe bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="update-the-s3-bucket"\u003eUpdate the S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eread -r -d \'\' BUCKET_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: $BUCKET_NAME\nspec:\n name: $BUCKET_NAME\n tagging:\n tagSet:\n - key: myTagKey\n value: myTagValue\nEOF\n\necho \u0026quot;${BUCKET_MANIFEST}\u0026quot; \u0026gt; bucket.yaml\n\nkubectl apply -f bucket.yaml\n\nkubectl describe bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-the-s3-bucket"\u003eDelete the S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f bucket.yaml\n\n# verify the bucket no longer exists\nkubectl get bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that you have verified ACK service controller functionality, \u003ca href="../multi-region-resource-management"\u003echeckout ACK\nfunctionality for creating resources in multiple AWS regions.\u003c/a\u003e\u003c/p\u003e\n'}).add({id:13,href:"https://aws-controllers-k8s.github.io/community/docs/community/discussions/",title:"Discussions",description:"",content:'\u003cp\u003eFor discussions, please use the \u003ccode\u003e#aws-controllers-k8s\u003c/code\u003e channel on the \u003ca href="https://kubernetes.slack.com/"\u003eKubernetes Slack community\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:14,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/sagemaker-example/",title:"Machine Learning with the ACK SageMaker Controller",description:"Train a machine learning model with the ACK service controller for Amazon SageMaker using Amazon Elastic Kubernetes Service",content:'\u003cp\u003eThe SageMaker ACK service controller makes it easier for machine learning developers and data scientists who use Kubernetes as their control plane to train, tune, and deploy machine learning models in Amazon SageMaker without logging into the SageMaker console.\u003c/p\u003e\n\u003cp\u003eThe following steps will guide you through the setup and use of the Amazon SageMaker ACK service controller for training a machine learning model.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq"\u003eyq\u003c/a\u003e - A command line tool for YAML processing. (For Linux environments, use the \u003ca href="https://github.com/mikefarah/yq/#wget"\u003e\u003ccode\u003ewget\u003c/code\u003e plain binary installation\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://everything.curl.dev/get"\u003ecurl\u003c/a\u003e - A command line tool for transmitting data with URLs.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role and attach an IAM policy to that role to ensure that your SageMaker service controller has access to the appropriate AWS resources. First, check to make sure that you are connected to an Amazon EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport CLUSTER_NAME=\u0026lt;CLUSTER_NAME\u0026gt;\nexport SERVICE_REGION=\u0026lt;CLUSTER_REGION\u0026gt;\naws eks update-kubeconfig --name $CLUSTER_NAME --region $SERVICE_REGION\nkubectl config get-contexts\n# Ensure cluster has compute\nkubectl get nodes\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBefore you can deploy your SageMaker service controller using an IAM role, associate an OpenID Connect (OIDC) provider with your IAM role to authenticate your cluster with the IAM service.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eeksctl utils associate-iam-oidc-provider --cluster ${CLUSTER_NAME} \\\n--region ${SERVICE_REGION} --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following OIDC information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport OIDC_PROVIDER_URL=$(aws eks describe-cluster --name $CLUSTER_NAME --region $SERVICE_REGION \\\n--query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | cut -c9-)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn your working directory, create a file named \u003ccode\u003etrust.json\u003c/code\u003e using the following trust relationship code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':oidc-provider/\'$OIDC_PROVIDER_URL\'\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;\'$OIDC_PROVIDER_URL\':aud\u0026quot;: \u0026quot;sts.amazonaws.com\u0026quot;,\n \u0026quot;\'$OIDC_PROVIDER_URL\':sub\u0026quot;: [\n \u0026quot;system:serviceaccount:ack-system:ack-sagemaker-controller\u0026quot;,\n \u0026quot;system:serviceaccount:ack-system:ack-applicationautoscaling-controller\u0026quot;\n ]\n }\n }\n }\n ]\n}\n\' \u0026gt; ./trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003eiam create-role\u003c/code\u003e command to create an IAM role with the trust relationship you just defined in \u003ccode\u003etrust.json\u003c/code\u003e. This IAM role enables the Amazon EKS cluster to get and refresh credentials from IAM.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport OIDC_ROLE_NAME=ack-controller-role-$CLUSTER_NAME\naws --region $SERVICE_REGION iam create-role --role-name $OIDC_ROLE_NAME --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the AmazonSageMakerFullAccess Policy to the IAM Role to ensure that your SageMaker service controller has access to the appropriate resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam attach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\nexport IAM_ROLE_ARN_FOR_IRSA=$(aws --region $SERVICE_REGION iam get-role --role-name $OIDC_ROLE_NAME --output text --query \'Role.Arn\')\necho $IAM_ROLE_ARN_FOR_IRSA\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003ccode\u003eAmazonSageMakerFullAccess\u003c/code\u003e policy does not include permissions required to manage Domain, UserProfile or App resource. Create and attach the following Policy to the IAM Role to ensure that your SageMaker service controller has access to these resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Sid\u0026quot;: \u0026quot;SagemakerStudioAccess\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sagemaker:*\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sagemaker:*:*:domain/*\u0026quot;,\n \u0026quot;arn:aws:sagemaker:*:*:user-profile/*\u0026quot;,\n \u0026quot;arn:aws:sagemaker:*:*:app/*\u0026quot;\n ]\n }\n ]\n}\n\' \u0026gt; ./sagemaker_studio_access.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam put-role-policy --role-name $OIDC_ROLE_NAME --policy-name SagemakerStudioAccess --policy-document file://sagemaker_studio_access.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor more information on authorization and access for ACK service controllers, including details regarding recommended IAM policies, see \u003ca href="../../user-docs/authorization/"\u003eConfigure Permissions\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IAM role permissions for SageMaker resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you want to give more granular permissions, the full list of permissions required for each SageMaker resource can be found here : \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html"\u003eSageMaker API permissions\u003c/a\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="install-the-sagemaker-ack-service-controller"\u003eInstall the SageMaker ACK service controller\u003c/h3\u003e\n\u003cp\u003eGet the SageMaker Helm chart and make it available on the client machine with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport HELM_EXPERIMENTAL_OCI=1\nexport SERVICE=sagemaker\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\n\nif [[ -z \u0026quot;$RELEASE_VERSION\u0026quot; ]]; then\n RELEASE_VERSION=v1.2.0\nfi\n\nexport CHART_EXPORT_PATH=/tmp/chart\nexport CHART_REF=$SERVICE-chart\nexport CHART_REPO=public.ecr.aws/aws-controllers-k8s/$CHART_REF\nexport CHART_PACKAGE=$CHART_REF-$RELEASE_VERSION.tgz\n\nmkdir -p $CHART_EXPORT_PATH\n\nhelm pull oci://$CHART_REPO --version $RELEASE_VERSION -d $CHART_EXPORT_PATH\ntar xvf $CHART_EXPORT_PATH/$CHART_PACKAGE -C $CHART_EXPORT_PATH\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdate the Helm chart values for a cluster-scoped installation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the following values in the Helm chart\ncd $CHART_EXPORT_PATH/$SERVICE-chart\nyq e \'.aws.region = env(SERVICE_REGION)\' -i values.yaml\nyq e \'.serviceAccount.annotations.\u0026quot;eks.amazonaws.com/role-arn\u0026quot; = env(IAM_ROLE_ARN_FOR_IRSA)\' -i values.yaml\ncd -\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall the relevant custom resource definitions (CRDs) for the SageMaker ACK service controller.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a namespace and install the SageMaker ACK service controller with the Helm chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_K8S_NAMESPACE=ack-system\nhelm install -n $ACK_K8S_NAMESPACE --create-namespace --skip-crds ack-$SERVICE-controller \\\n $CHART_EXPORT_PATH/$SERVICE-chart\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the CRDs and Helm charts were deployed with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get crds | grep \u0026quot;services.k8s.aws\u0026quot;\nkubectl get pods -n $ACK_K8S_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="train-an-xgboost-model"\u003eTrain an XGBoost model\u003c/h2\u003e\n\u003ch3 id="prepare-your-data"\u003ePrepare your data\u003c/h3\u003e\n\u003cp\u003eFor training a model with SageMaker, we will need an S3 bucket to store the dataset and model training artifacts. For this example, we will use \u003ca href="http://yann.lecun.com/exdb/mnist/"\u003eMNIST\u003c/a\u003e data stored in \u003ca href="https://www.csie.ntu.edu.tw/~cjlin/libsvm/"\u003eLIBSVM\u003c/a\u003e format.\u003c/p\u003e\n\u003cp\u003eFirst, create a variable for the S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport SAGEMAKER_BUCKET=ack-sagemaker-bucket-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen, create a file named \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e with the following code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\n#!/usr/bin/env bash\n# Create the S3 bucket\nif [[ $SERVICE_REGION != \u0026quot;us-east-1\u0026quot; ]]; then\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot; --create-bucket-configuration LocationConstraint=\u0026quot;$SERVICE_REGION\u0026quot;\nelse\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot;\nfi\' \u0026gt; ./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e script to create an S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003echmod +x create-bucket.sh\n./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCopy the MNIST data into your S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ewget https://raw.githubusercontent.com/aws-controllers-k8s/sagemaker-controller/main/samples/training/s3_sample_data.py\npython3 s3_sample_data.py $SAGEMAKER_BUCKET\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="configure-permissions-for-your-training-job"\u003eConfigure permissions for your training job\u003c/h3\u003e\n\u003cp\u003eThe SageMaker training job that we execute will need an IAM role to access Amazon S3 and Amazon SageMaker. Run the following commands to create a SageMaker execution IAM role that will be used by SageMaker to access the appropriate AWS resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SAGEMAKER_EXECUTION_ROLE_NAME=ack-sagemaker-execution-role-$ACCOUNT_ID\n\nTRUST=\u0026quot;{ \\\u0026quot;Version\\\u0026quot;: \\\u0026quot;2012-10-17\\\u0026quot;, \\\u0026quot;Statement\\\u0026quot;: [ { \\\u0026quot;Effect\\\u0026quot;: \\\u0026quot;Allow\\\u0026quot;, \\\u0026quot;Principal\\\u0026quot;: { \\\u0026quot;Service\\\u0026quot;: \\\u0026quot;sagemaker.amazonaws.com\\\u0026quot; }, \\\u0026quot;Action\\\u0026quot;: \\\u0026quot;sts:AssumeRole\\\u0026quot; } ] }\u0026quot;\naws iam create-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --assume-role-policy-document \u0026quot;$TRUST\u0026quot;\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\n\nSAGEMAKER_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --output text --query \'Role.Arn\')\n\necho $SAGEMAKER_EXECUTION_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-sagemaker-training-job"\u003eCreate a SageMaker training job\u003c/h3\u003e\n\u003cp\u003eGive your SageMaker training job a unique name:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport JOB_NAME=ack-xgboost-training-job-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSpecify your region-specific XGBoost image URI:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport XGBOOST_IMAGE=683313688378.dkr.ecr.us-east-1.amazonaws.com/sagemaker-xgboost:1.2-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Change XGBoost image URI based on region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eIMPORTANT\u003c/strong\u003e: If your \u003ccode\u003eSERVICE_REGION\u003c/code\u003e is not \u003ccode\u003eus-east-1\u003c/code\u003e, you must change the \u003ccode\u003eXGBOOST_IMAGE\u003c/code\u003e URI. To find your region-specific XGBoost image URI, choose your region in the \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html"\u003eSageMaker Docker Registry Paths page\u003c/a\u003e, and then select \u003cstrong\u003eXGBoost (algorithm)\u003c/strong\u003e. For this example, use version 1.2-1.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, create a \u003ccode\u003etraining.yaml\u003c/code\u003e file to specify the parameters for your SageMaker training job. This file specifies your SageMaker training job name, any relevant hyperparameters, and the location of your training and validation data. You can also use this document to specify which Amazon Elastic Container Registry (ECR) image to use for training.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eprintf \'\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: TrainingJob\nmetadata:\n name: \'$JOB_NAME\'\nspec:\n # Name that will appear in the SageMaker console\n trainingJobName: \'$JOB_NAME\'\n hyperParameters: \n max_depth: \u0026quot;5\u0026quot;\n gamma: \u0026quot;4\u0026quot;\n eta: \u0026quot;0.2\u0026quot;\n min_child_weight: \u0026quot;6\u0026quot;\n objective: \u0026quot;multi:softmax\u0026quot;\n num_class: \u0026quot;10\u0026quot;\n num_round: \u0026quot;10\u0026quot;\n algorithmSpecification:\n # The URL and tag of your ECR container\n trainingImage: \'$XGBOOST_IMAGE\'\n trainingInputMode: File\n # A role with SageMaker and S3 access\n roleARN: \'$SAGEMAKER_EXECUTION_ROLE_ARN\' \n outputDataConfig:\n # The output path of your model\n s3OutputPath: s3://\'$SAGEMAKER_BUCKET\' \n resourceConfig:\n instanceCount: 1\n instanceType: ml.m4.xlarge\n volumeSizeInGB: 5\n stoppingCondition:\n maxRuntimeInSeconds: 86400\n inputDataConfig:\n - channelName: train\n dataSource:\n s3DataSource:\n s3DataType: S3Prefix\n # The input path of your train data \n s3URI: s3://\'$SAGEMAKER_BUCKET\'/sagemaker/xgboost/train\n s3DataDistributionType: FullyReplicated\n contentType: text/libsvm\n compressionType: None\n - channelName: validation\n dataSource:\n s3DataSource:\n s3DataType: S3Prefix\n # The input path of your validation data \n s3URI: s3://\'$SAGEMAKER_BUCKET\'/sagemaker/xgboost/validation\n s3DataDistributionType: FullyReplicated\n contentType: text/libsvm\n compressionType: None\n\' \u0026gt; ./training.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUse your \u003ccode\u003etraining.yaml\u003c/code\u003e file to create a SageMaker training job:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f training.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your \u003ccode\u003etraining.yaml\u003c/code\u003e file, you should see that your training job was successfully created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003etrainingjob.sagemaker.services.k8s.aws/ack-xgboost-training-job-7420 created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can watch the status of the training job with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get trainingjob.sagemaker --watch\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIt will a take a few minutes for \u003ccode\u003eTRAININGJOBSTATUS\u003c/code\u003e to be \u003ccode\u003eCompleted\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SECONDARYSTATUS TRAININGJOBSTATUS\nack-xgboost-training-job-7420 Starting InProgress\nack-xgboost-training-job-7420 Downloading InProgress\nack-xgboost-training-job-7420 Training InProgress\nack-xgboost-training-job-7420 Completed Completed\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo see details about your training job, run the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe trainingjobs $JOB_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf your training job completed successfully, you can find the model location under \u003ccode\u003estatus.modelArtifacts.s3ModelArtifacts\u003c/code\u003e. If your training job failed, look to the \u003ccode\u003estatus.failureReason\u003c/code\u003e for more information.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eFor more examples on how to use the SageMaker ACK service controller, see the \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/tree/main/samples"\u003eSageMaker controller samples repository\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo deploy your trained SageMaker model and scale it with the Application Auto Scaling ACK service controller, see \u003ca href="../autoscaling-example/"\u003eScale SageMaker Workloads with Application Auto Scaling\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your SageMaker training job with the \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete trainingjob $JOB_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SageMaker ACK service controller, related CRDs, and namespaces see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIt is recommended to delete any additional resources such as S3 buckets, IAM roles, and IAM policies when you no longer need them. You can delete these resources with the following commands or directly in the AWS console.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Delete S3 bucket\naws s3 rb s3://$SAGEMAKER_BUCKET --force\n\n# Delete SageMaker execution role\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\naws iam delete-role --role-name $SAGEMAKER_EXECUTION_ROLE_NAME\n\n# Delete IAM role created for IRSA\naws iam detach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam delete-role --role-name $OIDC_ROLE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:15,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/multi-region-resource-management/",title:"Manage Resources In Multiple Regions",description:"Managing resources in multiple AWS regions",content:'\u003cp\u003eYou can manage resources in multiple AWS regions using a single ACK service controller. To determine the AWS region for a given resource, the ACK service controller looks for region information in the following order:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eThe region annotation \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e on the resource.\u003c/li\u003e\n\u003cli\u003eThe region annotation \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e on the resource\u0026rsquo;s namespace.\u003c/li\u003e\n\u003cli\u003eThe \u003ccode\u003e--aws-region\u003c/code\u003e controller flag. This flag may be set using the \u003ccode\u003eaws.region\u003c/code\u003e Helm chart variable.\u003c/li\u003e\n\u003cli\u003eKubernetes pod \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003eIRSA\u003c/a\u003e environment variables.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eFor example, the \u003ccode\u003e--aws-region\u003c/code\u003e ACK service controller flag is \u003ccode\u003eus-west-2\u003c/code\u003e. If you want to create a resource in \u003ccode\u003eus-east-1\u003c/code\u003e, use one of the following options to override the default region.\u003c/p\u003e\n\u003ch2 id="option-1-region-annotation"\u003eOption 1: Region annotation\u003c/h2\u003e\n\u003cp\u003eAdd the \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e annotation while creating the resource. For example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n annotations:\n services.k8s.aws/region: us-east-1\nspec:\n name: my-bucket\n ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="option-2-namespace-default-region-annotation"\u003eOption 2: Namespace default region annotation\u003c/h2\u003e\n\u003cp\u003eTo bind a region to a specific namespace, you will have to annotate the namespace with the \u003ccode\u003eservices.k8s.aws/default-region\u003c/code\u003e annotation.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Namespace-scoped deployment does not support this option\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Use this solution for multi-region resource management on cluster-scoped deployments.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Namespace\nmetadata:\n name: production\n annotations:\n services.k8s.aws/default-region: us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor existing namespaces, you can run:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl annotate namespace production services.k8s.aws/default-region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can also create the resource in the same namespace:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n namespace: production\nspec:\n name: my-bucket\n ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eCheckout ACK functionality for \u003ca href="../cross-account-resource-management"\u003ecreating resources in multiple AWS accounts from single controller installation.\u003c/a\u003e\u003c/p\u003e\n'}).add({id:16,href:"https://aws-controllers-k8s.github.io/community/docs/community/services/",title:"Services",description:"Project status of each supported service",content:'\u003cp\u003eThe following AWS service APIs have service controllers included in ACK or have\ncontrollers in one of our \u003ca href="../releases#project-stages"\u003eseveral project stages\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eACK controllers that have reached the \u003ccode\u003eRELEASED\u003c/code\u003e project stage will also be in\none of our \u003ca href="../releases#maintenance-phases"\u003emaintenance phases\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor details, including a list of planned AWS service APIs, see the \u003ca href="https://github.com/aws-controllers-k8s/community/projects/1"\u003eService\nController Release Roadmap\u003c/a\u003e:\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-danger"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IMPORTANT\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n There is no single release of the ACK project. The ACK project contains a\nseries of service controllers, one for each AWS service API. Each\nindividual ACK service controller is released separately. Please see the\n\u003ca href="../releases"\u003erelease documentation\u003c/a\u003e for information on how we version and\nrelease ACK service controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth style="text-align:left"\u003eMaintenance Phase\u003c/th\u003e\n\u003cth style="text-align:right"\u003e# Services\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:left"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e18\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:left"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e20\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth style="text-align:right"\u003eAWS Service\u003c/th\u003e\n\u003cth style="text-align:right"\u003eProject Stage\u003c/th\u003e\n\u003cth style="text-align:right"\u003eMaintenance Phase\u003c/th\u003e\n\u003cth style="text-align:right"\u003eLatest Version\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-acm"\u003eACM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/acm-controller/releases/tag/v0.0.14"\u003e0.0.14\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-prometheus-service"\u003ePrometheus Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/prometheusservice-controller/releases/tag/v1.2.9"\u003e1.2.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-api-gateway"\u003eAPI Gateway\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-apigatewayv2"\u003eApiGatewayV2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/releases/tag/v1.0.10"\u003e1.0.10\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-application-auto-scaling"\u003eApplication Auto Scaling\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller/releases/tag/v1.0.12"\u003e1.0.12\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-app-runner"\u003eApp Runner\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-athena"\u003eAthena\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-auto-scaling-plans"\u003eAuto Scaling Plans\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-auto-scaling"\u003eAuto Scaling\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-backup"\u003eBackup\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudfront"\u003eCloudFront\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudfront-controller/releases/tag/v0.0.9"\u003e0.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudtrail"\u003eCloudTrail\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudtrail-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cognito-identity-provider"\u003eCognito Identity Provider\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-dynamodb"\u003eDynamoDB\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/releases/tag/v1.2.9"\u003e1.2.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ec2"\u003eEC2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/releases/tag/v1.2.4"\u003e1.2.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ecr"\u003eECR\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/releases/tag/v1.0.13"\u003e1.0.13\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ecs"\u003eECS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ecs-controller/releases/tag/v0.0.4"\u003e0.0.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-eks"\u003eEKS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/eks-controller/releases/tag/v1.3.2"\u003e1.3.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-elasticache"\u003eElastiCache\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller/releases/tag/v0.0.29"\u003e0.0.29\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-efs"\u003eEFS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/efs-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ses"\u003eSES\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-emr-containers"\u003eEMR Containers\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/emrcontainers-controller/releases/tag/v1.0.8"\u003e1.0.8\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-elasticsearch-service"\u003eElasticsearch Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/elasticsearchservice-controller/releases/tag/v0.0.2"\u003e0.0.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-eventbridge"\u003eEventBridge\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-fsx"\u003eFSx\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-iam"\u003eIAM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/iam-controller/releases/tag/v1.3.5"\u003e1.3.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kafka"\u003eKafka\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kafka-controller/releases/tag/v0.0.3"\u003e0.0.3\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-keyspaces"\u003eKeyspaces\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/keyspaces-controller/releases/tag/v0.0.11"\u003e0.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kinesis"\u003eKinesis\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kinesis-controller/releases/tag/v0.0.13"\u003e0.0.13\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kms"\u003eKMS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kms-controller/releases/tag/v1.0.11"\u003e1.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-lambda"\u003eLambda\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/releases/tag/v1.4.2"\u003e1.4.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudwatch-logs"\u003eCloudWatch Logs\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudwatchlogs-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-memorydb"\u003eMemoryDB\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/releases/tag/v1.0.2"\u003e1.0.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudwatch"\u003eCloudWatch\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudwatch-controller/releases/tag/v0.0.6"\u003e0.0.6\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-mq"\u003eMQ\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/mq-controller/releases/tag/v0.0.32"\u003e0.0.32\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-neptune"\u003eNeptune\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-network-firewall"\u003eNetwork Firewall\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/networkfirewall-controller/releases/tag/v0.0.3"\u003e0.0.3\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-opensearch-service"\u003eOpenSearch Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/opensearchservice-controller/releases/tag/v0.0.22"\u003e0.0.22\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-organizations"\u003eOrganizations\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/organizations-controller/releases/tag/v0.0.4"\u003e0.0.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ram"\u003eRAM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-recycle-bin"\u003eRecycle Bin\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-rds"\u003eRDS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/rds-controller/releases/tag/v1.2.1"\u003e1.2.1\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-route-53"\u003eRoute 53\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/route53-controller/releases/tag/v0.0.12"\u003e0.0.12\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-route53resolver"\u003eRoute53Resolver\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/route53resolver-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-s3"\u003eS3\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/s3-controller/releases/tag/v1.0.10"\u003e1.0.10\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sagemaker"\u003eSageMaker\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/releases/tag/v1.2.7"\u003e1.2.7\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-secrets-manager"\u003eSecrets Manager\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/secretsmanager-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-service-catalog"\u003eService Catalog\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sns"\u003eSNS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sns-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sqs"\u003eSQS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sqs-controller/releases/tag/v1.0.11"\u003e1.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ssm"\u003eSSM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-sfn"\u003eSFN\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sfn-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-wafv2"\u003eWAFV2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Don\u0026rsquo;t see a service listed?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you don\u0026rsquo;t see a particular AWS service listed, feel free to\n\u003ca href="https://github.com/aws-controllers-k8s/community/issues/new?labels=Service+Controller\u0026amp;template=propose_new_controller.md\u0026amp;title=%5Bname%5D+service+controller"\u003epropose it\u003c/a\u003e!\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="amazon-acm"\u003eAmazon ACM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/acm-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/acm-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/482" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/482\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/acm-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/acm-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-prometheus-service"\u003eAmazon Prometheus Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/prometheusservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/prometheusservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/prometheusservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/prometheusservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-api-gateway"\u003eAmazon API Gateway\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/apigateway-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/apigateway-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1126" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1126\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-apigatewayv2"\u003eAmazon ApiGatewayV2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/apigatewayv2-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/apigatewayv2-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/apigatewayv2-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-application-auto-scaling"\u003eAmazon Application Auto Scaling\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/applicationautoscaling-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/applicationautoscaling-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/applicationautoscaling-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-app-runner"\u003eAWS App Runner\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1616" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1616\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-athena"\u003eAmazon Athena\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1597" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1597\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-auto-scaling-plans"\u003eAWS Auto Scaling Plans\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/590" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/590\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-auto-scaling"\u003eAmazon Auto Scaling\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/autoscaling-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/autoscaling-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/588" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/588\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-backup"\u003eAWS Backup\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/2023" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/2023\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudfront"\u003eAmazon CloudFront\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudfront-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudfront-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/249" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/249\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudfront-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudfront-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudtrail"\u003eAmazon CloudTrail\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudtrail-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudtrail-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudtrail-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudtrail-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cognito-identity-provider"\u003eAmazon Cognito Identity Provider\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1211" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1211\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-dynamodb"\u003eAmazon DynamoDB\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/dynamodb-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/dynamodb-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/dynamodb-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ec2"\u003eAmazon EC2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ec2-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/490" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/490\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ec2-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ec2-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ecr"\u003eAmazon ECR\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ecr-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecr-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecr-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ecs"\u003eAmazon ECS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ecs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ecs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1592" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1592\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-eks"\u003eAmazon EKS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/eks-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/eks-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eks-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eks-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-elasticache"\u003eAmazon ElastiCache\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/elasticache-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/240" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/240\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticache-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticache-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-efs"\u003eAmazon EFS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/efs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/efs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/328" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/328\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/efs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/efs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ses"\u003eAmazon SES\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/493" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/493\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-emr-containers"\u003eAmazon EMR Containers\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/emrcontainers-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/emrcontainers-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/emrcontainers-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/emrcontainers-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-elasticsearch-service"\u003eAmazon Elasticsearch Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/elasticsearchservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/elasticsearchservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticsearchservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticsearchservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-eventbridge"\u003eAmazon EventBridge\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/eventbridge-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eventbridge-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eventbridge-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-fsx"\u003eAmazon FSx\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1485" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1485\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-iam"\u003eAmazon IAM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/iam-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/iam-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/iam-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/iam-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kafka"\u003eAmazon Kafka\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kafka-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kafka-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/348" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/348\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kafka-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kafka-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-keyspaces"\u003eAmazon Keyspaces\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/keyspaces-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/keyspaces-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1801" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1801\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/keyspaces-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/keyspaces-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kinesis"\u003eAmazon Kinesis\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kinesis-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kinesis-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/235" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/235\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kinesis-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kinesis-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kms"\u003eAmazon KMS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kms-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kms-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kms-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kms-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-lambda"\u003eAWS Lambda\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/lambda-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/lambda-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/lambda-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudwatch-logs"\u003eAmazon CloudWatch Logs\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudwatchlogs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudwatchlogs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatchlogs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatchlogs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-memorydb"\u003eAmazon MemoryDB\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/memorydb-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/memorydb-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/memorydb-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudwatch"\u003eAmazon CloudWatch\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudwatch-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudwatch-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1093" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1093\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatch-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatch-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-mq"\u003eAmazon MQ\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/mq-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/mq-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/390" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/390\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/mq-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/mq-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-neptune"\u003eAmazon Neptune\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1768" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1768\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-network-firewall"\u003eAmazon Network Firewall\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/networkfirewall-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/networkfirewall-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/networkfirewall-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/networkfirewall-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-opensearch-service"\u003eAmazon OpenSearch Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/opensearchservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/opensearchservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/opensearchservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/opensearchservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-organizations"\u003eAmazon Organizations\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/organizations-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/organizations-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/716" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/716\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/organizations-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/organizations-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ram"\u003eAmazon RAM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/492" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/492\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-recycle-bin"\u003eAmazon Recycle Bin\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1870" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1870\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-rds"\u003eAmazon RDS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/rds-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/rds-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/rds-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/rds-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-route-53"\u003eAmazon Route 53\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/route53-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/route53-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/480" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/480\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-route53resolver"\u003eAmazon Route53Resolver\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/route53resolver-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/route53resolver-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1853" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1853\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53resolver-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53resolver-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-s3"\u003eAmazon S3\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/s3-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/s3-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sagemaker"\u003eAmazon SageMaker\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sagemaker-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sagemaker-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sagemaker-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-secrets-manager"\u003eAWS Secrets Manager\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/secretsmanager-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/secretsmanager-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/628" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/628\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/secretsmanager-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/secretsmanager-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-service-catalog"\u003eAWS Service Catalog\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/servicecatalog-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/servicecatalog-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1026" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1026\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sns"\u003eAmazon SNS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sns-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sns-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sns-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sns-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sqs"\u003eAmazon SQS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sqs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sqs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sqs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sqs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ssm"\u003eAmazon SSM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ssm-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ssm-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/485" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/485\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-sfn"\u003eAWS SFN\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sfn-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sfn-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sfn-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sfn-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-wafv2"\u003eAmazon WAFV2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1300" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1300\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:17,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/setup/",title:"Setup",description:"Setting up the development environment",content:'\u003cp\u003eWe walk you now through the setup to start contributing to the AWS Controller\nfor Kubernetes (ACK) project. No matter if you\u0026rsquo;re contributing code or docs,\nfollow the steps below to set up your development environment.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Issue before PR\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Of course we\u0026rsquo;re happy about code drops via PRs, however, in order to give\nus time to plan ahead and also to avoid disappointment, consider creating\nan issue first and submit a PR later. This also helps us to coordinate\nbetween different contributors and should in general help keeping everyone\nhappy.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003ePlease ensure that you have \u003ca href="https://golang.org/doc/install"\u003eproperly installed Go\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Go version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Our repositories require a Go version of \u003ccode\u003e1.19\u003c/code\u003e or above for development.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="fork-upstream-repositories"\u003eFork upstream repositories\u003c/h2\u003e\n\u003cp\u003eThe first step in setting up your ACK development environment is to fork the\nupstream ACK source code repositories to your personal Github account.\u003c/p\u003e\n\u003cp\u003eThere are three common upstream repositories you should fork first:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e is the core ACK runtime and types\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e is the ACK code generator\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e contains the testing scripts\u003c/li\u003e\n\u003c/ul\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Prefix ACK forked repos with \u003ccode\u003eack-\u003c/code\u003e\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When I fork repositories to my personal Github account, I tend to prefix\nthe repositories with a common string for grouping purposes. For ACK source\nrepositories that I forked from the \u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github\nOrganization, I prefix those repositories with \u0026ldquo;ack-\u0026rdquo;. For example, when I\nforked the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e repository to my\n\u003ccode\u003egithub.com/jaypipes\u003c/code\u003e personal space on Github, I immediately renamed the\nforked repo to \u003ccode\u003egithub.com/jaypipes/ack-code-generator\u003c/code\u003e. This makes it easier\nto quickly filter repositories that are forked from the\n\u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github Organization.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAfter forking the above common repositories, fork the upstream service\ncontroller repositories that you wish to work on or test out. The upstream\nservice controller repositories are in the \u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e\nGithub Organization and follow a naming schema of \u003ccode\u003e$SERVICE_ALIAS-controller\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eSo, if you wanted to work on the S3 service controller, you would fork the\n\u003ccode\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/code\u003e source repository to your\npersonal Github space.\u003c/p\u003e\n\u003ch2 id="ensure-source-code-organization-directories-exist"\u003eEnsure source code organization directories exist\u003c/h2\u003e\n\u003cp\u003eMake sure in your \u003ccode\u003e$GOPATH/src\u003c/code\u003e that you have directories for the\n\u003ccode\u003eaws-controllers-k8s\u003c/code\u003e organization:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emkdir -p $GOPATH/src/github.com/aws-controllers-k8s\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Contributing to ACK core repositories\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you plan to make changes to one of the ACK core repositories e.g.,\n\u003ccode\u003ecode-generator \u003c/code\u003e, you might see errors in your IDE, such as \u003ccode\u003eUnresolved Type \u0026quot;Operation\u0026quot;\u003c/code\u003e. This is because some packages, like\n\u003ccode\u003egithub.com/aws/aws-sdk-go/private/model/api\u003c/code\u003e use Go build tags which some IDEs\ndo not enable by default. For Goland, build tag documentation can be found\n\u003ca href="https://www.jetbrains.com/help/go/configuring-build-constraints-and-vendoring.html#configure-build-constraints-for-your-project"\u003ehere\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="git-clone-forked-repositories-and-add-upstream-remote"\u003e\u003ccode\u003egit clone\u003c/code\u003e forked repositories and add upstream remote\u003c/h2\u003e\n\u003cp\u003eFor each of your forked repositories, you will \u003ccode\u003egit clone\u003c/code\u003e the repository into\nthe appropriate folder in your \u003ccode\u003e$GOPATH\u003c/code\u003e. Once \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d, you will want to\nset up a Git remote called \u0026ldquo;upstream\u0026rdquo; (remember that \u0026ldquo;origin\u0026rdquo; will be pointing\nat your forked repository location in your personal Github space).\u003c/p\u003e\n\u003cp\u003eYou can use this script to do this for you:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eGITHUB_ID=\u0026quot;your GH username\u0026quot;\n\n# Set this to \u0026quot;\u0026quot; if you did NOT take my advice above in the tip about prefixing\n# your personal forked ACK repository names with \u0026quot;ack-\u0026quot;\nACK_REPO_PREFIX=\u0026quot;ack-\u0026quot;\n\n# Clone all the common ACK repositories...\nCOMMON=\u0026quot;runtime code-generator test-infra\u0026quot;\nfor REPO in $COMMON; do\n cd $GOPATH/src/github.com/aws-controllers-k8s\n git clone git@github.com:$GITHUB_ID/$ACK_REPO_PREFIX$REPO $REPO\n cd $REPO\n git remote add upstream git@github.com:aws-controllers-k8s/$REPO\n git fetch --all\ndone\n\n# Now clone all the service controller repositories...\n# Change this to the list of services you forked service controllers for...\nSERVICES=\u0026quot;s3 sns ecr\u0026quot;\nfor SERVICE in $SERVICES; do\n cd $GOPATH/src/github.com/aws-controllers-k8s\n git clone git@github.com:$GITHUB_ID/$ACK_REPO_PREFIX$SERVICE-controller $SERVICE-controller\n cd $SERVICE-controller\n git remote add upstream git@github.com:aws-controllers-k8s/$SERVICE-controller\n git fetch --all\ndone\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-your-local-branch"\u003eCreate your local branch\u003c/h2\u003e\n\u003cp\u003eNext, you create a local branch where you work on your feature or bug fix.\nLet\u0026rsquo;s say you want to enhance the docs, so set \u003ccode\u003eBRANCH_NAME=docs-improve\u003c/code\u003e and\nthen:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit fetch --all \u0026amp;\u0026amp; git checkout -b $BRANCH_NAME upstream/main\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="commit-changes"\u003eCommit changes\u003c/h2\u003e\n\u003cp\u003eMake your changes locally, commit and push using:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit commit -a -m \u0026quot;improves the docs a lot\u0026quot;\n\ngit push origin $BRANCH_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWith an example output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eEnumerating objects: 6, done.\nCounting objects: 100% (6/6), done.\nDelta compression using up to 8 threads\nCompressing objects: 100% (4/4), done.\nWriting objects: 100% (4/4), 710 bytes | 710.00 KiB/s, done.\nTotal 4 (delta 2), reused 0 (delta 0)\nremote: Resolving deltas: 100% (2/2), completed with 2 local objects.\nremote: This repository moved. Please use the new location:\nremote: git@github.com:$GITHUB_ID/aws-controllers-k8s.git\nremote: \nremote: Create a pull request for \'docs\' on GitHub by visiting:\nremote: https://github.com/$GITHUB_ID/aws-controllers-k8s/pull/new/docs\nremote: \nTo github.com:a-hilaly/aws-controllers-k8s\n * [new branch] docs -\u0026gt; docs\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-a-pull-request"\u003eCreate a pull request\u003c/h2\u003e\n\u003cp\u003eFinally, submit a pull request against the upstream source repository.\u003c/p\u003e\n\u003cp\u003eUse either the link that show up as in the example above or to the upstream\nsource repository and there open the pull request as depicted below:\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/github-pr.png" alt="images"\u003e\u003c/p\u003e\n\u003cp\u003eWe monitor the GitHub repo and try to follow up with comments within a working\nday.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eAfter getting familiar with the various ACK source code repositories, now learn\n\u003ca href="../building-controller"\u003ehow to build an ACK service controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:18,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/autoscaling-example/",title:"Scale SageMaker Workloads with Application Auto Scaling",description:"Scale a SageMaker endpoint with the ACK Application Auto Scaling service controller",content:'\u003cp\u003eThe Application Auto Scaling ACK service controller makes it easier for developers to automatically scale resources for individual AWS services. Application Auto Scaling allows you to configure automatic scaling for resources such as Amazon SageMaker endpoint variants.\u003c/p\u003e\n\u003cp\u003eIn this tutorial, we will use the Application Auto Scaling ACK service controller in conjunction with the SageMaker ACK service controller to automatically scale a deployed machine learning model.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003cp\u003eThis guide also assumes that you have a trained machine learning model that you are ready to dynamically scale with the Application Auto Scaling ACK service controller. To train a machine learning model using the SageMaker ACK service controller, see \u003ca href="../sagemaker-example/"\u003eMachine Learning with the ACK Service Controller\u003c/a\u003e and return to this guide when you have successfully completed a SageMaker training job.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eA trained machine learning model that you want to scale dynamically.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq"\u003eyq\u003c/a\u003e - A command line tool for YAML processing. (For Linux environments, use the \u003ca href="https://mikefarah.gitbook.io/yq/#wget"\u003e\u003ccode\u003ewget\u003c/code\u003e plain binary installation\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://everything.curl.dev/get"\u003ecurl\u003c/a\u003e - A command line tool for transmitting data with URLs.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role and attach an IAM policy to that role to ensure that your Application Auto Scaling service controller has access to the appropriate AWS resources. First, check to make sure that you are connected to an Amazon EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport CLUSTER_NAME=\u0026lt;CLUSTER_NAME\u0026gt;\nexport SERVICE_REGION=\u0026lt;CLUSTER_REGION\u0026gt;\naws eks update-kubeconfig --name $CLUSTER_NAME --region $SERVICE_REGION\nkubectl config current-context\nkubectl get nodes\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBefore you can deploy your ACK service controllers using an IAM role, associate an OpenID Connect (OIDC) provider with your IAM role to authenticate your cluster with the IAM service.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eeksctl utils associate-iam-oidc-provider --cluster ${CLUSTER_NAME} \\\n--region ${SERVICE_REGION} --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following OIDC information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport OIDC_PROVIDER_URL=$(aws eks describe-cluster --name $CLUSTER_NAME --region $SERVICE_REGION \\\n--query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | cut -c9-)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn your working directory, create a file named \u003ccode\u003etrust.json\u003c/code\u003e using the following trust relationship code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':oidc-provider/\'$OIDC_PROVIDER_URL\'\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;\'$OIDC_PROVIDER_URL\':aud\u0026quot;: \u0026quot;sts.amazonaws.com\u0026quot;,\n \u0026quot;\'$OIDC_PROVIDER_URL\':sub\u0026quot;: [\n \u0026quot;system:serviceaccount:ack-system:ack-sagemaker-controller\u0026quot;,\n \u0026quot;system:serviceaccount:ack-system:ack-applicationautoscaling-controller\u0026quot;\n ]\n }\n }\n }\n ]\n}\n\' \u0026gt; ./trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdating an Application Auto Scaling Scalable Target requires additional permissions. First, create a service-linked role for Application Auto Scaling.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-sh"\u003e aws iam create-service-linked-role --aws-service-name sagemaker.application-autoscaling.amazonaws.com\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a file named \u003ccode\u003epass_role_policy.json\u003c/code\u003e to create the policy required for the IAM role.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: \u0026quot;iam:PassRole\u0026quot;,\n \u0026quot;Resource\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':role/aws-service-role/sagemaker.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_SageMakerEndpoint\u0026quot;\n }\n ]\n}\n\' \u0026gt; ./pass_role_policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003eiam create-role\u003c/code\u003e command to create an IAM role with the trust relationship you just defined in \u003ccode\u003etrust.json\u003c/code\u003e. This IAM role enables the Amazon EKS cluster to get and refresh credentials from IAM.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport OIDC_ROLE_NAME=ack-controller-role-$CLUSTER_NAME\naws --region $SERVICE_REGION iam create-role --role-name $OIDC_ROLE_NAME --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the AmazonSageMakerFullAccess Policy to the IAM Role to ensure that your SageMaker service controller has access to the appropriate resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam attach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the \u003ccode\u003eiam:PassRole\u003c/code\u003e policy required for updating an Application Auto Scaling Scalable Target.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam put-role-policy --role-name $OIDC_ROLE_NAME --policy-name \u0026quot;iam-pass-role-policy\u0026quot; --policy-document file://pass_role_policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following IAM role information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport IAM_ROLE_ARN_FOR_IRSA=$(aws --region $SERVICE_REGION iam get-role --role-name $OIDC_ROLE_NAME --output text --query \'Role.Arn\')\necho $IAM_ROLE_ARN_FOR_IRSA\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor more information on authorization and access for ACK service controllers, including details regarding recommended IAM policies, see \u003ca href="../../user-docs/authorization/"\u003eConfigure Permissions\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="install-the-application-auto-scaling-ack-service-controller"\u003eInstall the Application Auto Scaling ACK service controller\u003c/h3\u003e\n\u003cp\u003eGet the Application Auto Scaling Helm chart and make it available on the client machine with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport HELM_EXPERIMENTAL_OCI=1\nexport SERVICE=applicationautoscaling\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\n\nif [[ -z \u0026quot;$RELEASE_VERSION\u0026quot; ]]; then\n RELEASE_VERSION=1.0.2\nfi \n\nexport CHART_EXPORT_PATH=/tmp/chart\nexport CHART_REF=$SERVICE-chart\nexport CHART_REPO=public.ecr.aws/aws-controllers-k8s/$CHART_REF\nexport CHART_PACKAGE=$CHART_REF-$RELEASE_VERSION.tgz\n\nmkdir -p $CHART_EXPORT_PATH\n\nhelm pull oci://$CHART_REPO --version $RELEASE_VERSION -d $CHART_EXPORT_PATH\ntar xvf $CHART_EXPORT_PATH/$CHART_PACKAGE -C $CHART_EXPORT_PATH\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdate the Helm chart values for a cluster-scoped installation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the following values in the Helm chart\ncd $CHART_EXPORT_PATH/$SERVICE-chart\nyq e \'.aws.region = env(SERVICE_REGION)\' -i values.yaml\nyq e \'.serviceAccount.annotations.\u0026quot;eks.amazonaws.com/role-arn\u0026quot; = env(IAM_ROLE_ARN_FOR_IRSA)\' -i values.yaml\ncd -\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall the relevant custom resource definitions (CRDs) for the Application Auto Scaling ACK service controller.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a namespace and install the Application Auto Scaling ACK service controller with the Helm chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_K8S_NAMESPACE=ack-system\nhelm install -n $ACK_K8S_NAMESPACE --create-namespace --skip-crds ack-$SERVICE-controller \\\n $CHART_EXPORT_PATH/$SERVICE-chart\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the CRDs and Helm charts were deployed with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get pods -A | grep applicationautoscaling\nkubectl get crd | grep applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo scale a SageMaker endpoint variant with the Application Auto Scaling ACK service controller, you will also need the SageMaker ACK service controller. For step-by-step installation instructions see \u003ca href="../sagemaker-example/#install-the-sagemaker-ack-service-controller"\u003eInstall the SageMaker ACK Service Controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prepare-your-pretrained-model"\u003ePrepare your pretrained model\u003c/h3\u003e\n\u003cp\u003eTo scale a SageMaker endpoint with Application Auto Scaling, we first need a pretrained model in an S3 bucket. For this example, we will be using a pretrained XGBoost model.\u003c/p\u003e\n\u003cp\u003eFirst, create a variable for the S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport SAGEMAKER_BUCKET=ack-sagemaker-bucket-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen, create a file named \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e with the following code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\n#!/usr/bin/env bash\n# Create the S3 bucket\nif [[ $SERVICE_REGION != \u0026quot;us-east-1\u0026quot; ]]; then\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot; --create-bucket-configuration LocationConstraint=\u0026quot;$SERVICE_REGION\u0026quot;\nelse\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot;\nfi\' \u0026gt; ./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e script to create an S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003echmod +x create-bucket.sh\n./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the pretrained model and copy it into your S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ewget https://github.com/aws/amazon-sagemaker-examples/raw/af6667bd0be3c9cdec23fecda7f0be6d0e3fa3ea/sagemaker_model_monitor/introduction/model/xgb-churn-prediction-model.tar.gz\naws s3 cp xgb-churn-prediction-model.tar.gz s3://$SAGEMAKER_BUCKET\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="configure-permissions-for-your-sagemaker-endpoint"\u003eConfigure permissions for your SageMaker endpoint\u003c/h3\u003e\n\u003cp\u003eThe SageMaker endpoint that we deploy will need an IAM role to access Amazon S3 and Amazon SageMaker. Run the following commands to create a SageMaker execution IAM role that will be used by SageMaker to access the appropriate AWS resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SAGEMAKER_EXECUTION_ROLE_NAME=ack-sagemaker-execution-role-$ACCOUNT_ID\n\nTRUST=\u0026quot;{ \\\u0026quot;Version\\\u0026quot;: \\\u0026quot;2012-10-17\\\u0026quot;, \\\u0026quot;Statement\\\u0026quot;: [ { \\\u0026quot;Effect\\\u0026quot;: \\\u0026quot;Allow\\\u0026quot;, \\\u0026quot;Principal\\\u0026quot;: { \\\u0026quot;Service\\\u0026quot;: \\\u0026quot;sagemaker.amazonaws.com\\\u0026quot; }, \\\u0026quot;Action\\\u0026quot;: \\\u0026quot;sts:AssumeRole\\\u0026quot; } ] }\u0026quot;\naws iam create-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --assume-role-policy-document \u0026quot;$TRUST\u0026quot;\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\n\nSAGEMAKER_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --output text --query \'Role.Arn\')\n\necho $SAGEMAKER_EXECUTION_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="deploy-a-sagemaker-endpoint"\u003eDeploy a SageMaker endpoint\u003c/h2\u003e\n\u003cp\u003eUse the SageMaker ACK service controller to create a model, an endpoint configuration, and an endpoint.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport RANDOM_VAR=$RANDOM\nexport MODEL_NAME=ack-xgboost-model-$RANDOM_VAR\nexport ENDPOINT_CONFIG_NAME=ack-xgboost-endpoint-config-$RANDOM_VAR\nexport ENDPOINT_NAME=ack-xgboost-endpoint-$RANDOM_VAR\nexport XGBOOST_IMAGE=683313688378.dkr.ecr.us-east-1.amazonaws.com/sagemaker-xgboost:1.2-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Change XGBoost image URI based on region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eIMPORTANT\u003c/strong\u003e: If your \u003ccode\u003eSERVICE_REGION\u003c/code\u003e is not \u003ccode\u003eus-east-1\u003c/code\u003e, you must change the \u003ccode\u003eXGBOOST_IMAGE\u003c/code\u003e URI. To find your region-specific XGBoost image URI, choose your region in the \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html"\u003eSageMaker Docker Registry Paths page\u003c/a\u003e, and then select \u003cstrong\u003eXGBoost (algorithm)\u003c/strong\u003e. For this example, use version 1.2-1.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eUse the following \u003ccode\u003edeploy.yaml\u003c/code\u003e file to deploy the model on an \u003ccode\u003eml.m5.large\u003c/code\u003e instance. To use your own model, change the \u003ccode\u003emodelDataURL\u003c/code\u003e value.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: Model\nmetadata:\n name: \'$MODEL_NAME\'\nspec:\n modelName: \'$MODEL_NAME\'\n primaryContainer:\n containerHostname: xgboost\n # The source of the model data\n modelDataURL: s3://\'$SAGEMAKER_BUCKET\'/xgb-churn-prediction-model.tar.gz\n image: \'$XGBOOST_IMAGE\'\n executionRoleARN: \'$SAGEMAKER_EXECUTION_ROLE_ARN\'\n---\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: EndpointConfig\nmetadata:\n name: \'$ENDPOINT_CONFIG_NAME\'\nspec:\n endpointConfigName: \'$ENDPOINT_CONFIG_NAME\'\n productionVariants:\n - modelName: \'$MODEL_NAME\'\n variantName: AllTraffic\n instanceType: ml.m5.large\n initialInstanceCount: 1\n---\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: Endpoint\nmetadata:\n name: \'$ENDPOINT_NAME\'\nspec:\n endpointName: \'$ENDPOINT_NAME\'\n endpointConfigName: \'$ENDPOINT_CONFIG_NAME\'\n\' \u0026gt; ./deploy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the endpoint by applying the \u003ccode\u003edeploy.yaml\u003c/code\u003e file.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f deploy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying the \u003ccode\u003edeploy.yaml\u003c/code\u003e file, you should see that the model, endpoint configuration, and endpoint were successfully created.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emodel.sagemaker.services.k8s.aws/ack-xgboost-model-7420 created\nendpointconfig.sagemaker.services.k8s.aws/ack-xgboost-endpoint-config-7420 created\nendpoint.sagemaker.services.k8s.aws/ack-xgboost-endpoint-7420 created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWatch the process with the \u003ccode\u003ekubectl get\u003c/code\u003e command. Deploying the endpoint may take some time.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get endpoints.sagemaker --watch\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe endpoint status will be \u003ccode\u003eInService\u003c/code\u003e when the endpoint is successfully deployed and ready for use.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME ENDPOINTSTATUS\nack-xgboost-endpoint-7420 Creating \nack-xgboost-endpoint-7420 InService \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="automatically-scale-your-sagemaker-endpoint"\u003eAutomatically scale your SageMaker endpoint\u003c/h2\u003e\n\u003cp\u003eScale your SageMaker endpoint using the Application Auto Scaling \u003ca href="https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalabletarget/"\u003e\u003ccode\u003eScalableTarget\u003c/code\u003e\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalingpolicy/"\u003e\u003ccode\u003eScalingPolicy\u003c/code\u003e\u003c/a\u003e resources.\u003c/p\u003e\n\u003ch3 id="create-a-scalable-target"\u003eCreate a scalable target\u003c/h3\u003e\n\u003cp\u003eCreate a scalable target with the \u003ccode\u003escalable-target.yaml\u003c/code\u003e file. The following file designates that a specified SageMaker endpoint variant can automatically scale to up to three instances.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: applicationautoscaling.services.k8s.aws/v1alpha1\nkind: ScalableTarget\nmetadata:\n name: ack-tutorial-endpoint-scalable-target\nspec:\n maxCapacity: 3\n minCapacity: 1\n resourceID: endpoint/\'$ENDPOINT_NAME\'/variant/AllTraffic\n scalableDimension: \u0026quot;sagemaker:variant:DesiredInstanceCount\u0026quot;\n serviceNamespace: sagemaker\n \' \u0026gt; ./scalable-target.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply your \u003ccode\u003escalable-target.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scalable-target.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your scalable target, you should see the following output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003escalabletarget.applicationautoscaling.services.k8s.aws/ack-tutorial-endpoint-scalable-target created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify that the \u003ccode\u003eScalableTarget\u003c/code\u003e was created with the \u003ccode\u003ekubectl describe\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe scalabletarget.applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-scaling-policy"\u003eCreate a scaling policy\u003c/h3\u003e\n\u003cp\u003eCreate a scaling policy with the \u003ccode\u003escaling-policy.yaml\u003c/code\u003e file. The following file creates a target tracking scaling policy that scales a specified SageMaker endpoint based on the number of variant invocations per instance. The scaling policy adds or removes capacity as required to keep this number close to the target value of 60.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: applicationautoscaling.services.k8s.aws/v1alpha1\nkind: ScalingPolicy\nmetadata:\n name: ack-tutorial-endpoint-scaling-policy\nspec:\n policyName: ack-tutorial-endpoint-scaling-policy\n policyType: TargetTrackingScaling\n resourceID: endpoint/\'$ENDPOINT_NAME\'/variant/AllTraffic\n scalableDimension: \u0026quot;sagemaker:variant:DesiredInstanceCount\u0026quot;\n serviceNamespace: sagemaker\n targetTrackingScalingPolicyConfiguration:\n targetValue: 60\n scaleInCooldown: 700\n scaleOutCooldown: 300\n predefinedMetricSpecification:\n predefinedMetricType: SageMakerVariantInvocationsPerInstance\n \' \u0026gt; ./scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply your \u003ccode\u003escaling-policy.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your scaling policy, you should see the following output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003escalingpolicy.applicationautoscaling.services.k8s.aws/ack-tutorial-endpoint-scaling-policy created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify that the \u003ccode\u003eScalingPolicy\u003c/code\u003e was created with the \u003ccode\u003ekubectl describe\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe scalingpolicy.applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eTo learn more about Application Auto Scaling on a SageMaker endpoint, see the \u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller/tree/main/samples/hosting-autoscaling-on-sagemaker"\u003eApplication Auto Scaling controller samples\u003c/a\u003e repository.\u003c/p\u003e\n\u003ch3 id="updates"\u003eUpdates\u003c/h3\u003e\n\u003cp\u003eTo update the \u003ccode\u003eScalableTarget\u003c/code\u003e and \u003ccode\u003eScalingPolicy\u003c/code\u003e parameters after the resources are created, make any changes to the \u003ccode\u003escalable-target.yaml\u003c/code\u003e or \u003ccode\u003escaling-policy.yaml\u003c/code\u003e files and reapply them with \u003ccode\u003ekubectl apply\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scalable-target.yaml\nkubectl apply -f scaling-policy.yaml.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your training jobs, endpoints, scalable targets, and scaling policies with the \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f deploy.yaml\nkubectl delete -f scalable-target.yaml\nkubectl delete -f scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SageMaker and Application Auto Scaling ACK service controllers, related CRDs, and namespaces see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIt is recommended to delete any additional resources such as S3 buckets, IAM roles, and IAM policies when you no longer need them. You can delete these resources with the following commands or directly in the AWS console.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Delete S3 bucket\naws s3 rb s3://$SAGEMAKER_BUCKET --force\n\n# Delete SageMaker execution role\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\naws iam delete-role --role-name $SAGEMAKER_EXECUTION_ROLE_NAME\n\n# Delete IAM role created for IRSA\naws iam detach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam delete-role --role-name $OIDC_ROLE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:19,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/rds-example/",title:"Deploy PostgreSQL, MySQL, MariaDB Instances Using the ACK RDS Controller",description:"Create managed PostgreSQL, MySQL, and MariaDB instances in Amazon Relational Database Service (RDS) from a Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eThe ACK service controller for Amazon Relational Database Service (RDS) lets you manage RDS database instances directly from Kubernetes. This includes the following database engines:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/aurora/"\u003eAmazon Aurora\u003c/a\u003e (MySQL \u0026amp; PostgreSQL)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/postgresql/"\u003eAmazon RDS for PostgreSQL\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/mysql/"\u003eAmazon RDS for MySQL\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/mariadb/"\u003eAmazon RDS for MariaDB\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/oracle/"\u003eAmazon RDS for Oracle\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/sqlserver/"\u003eAmazon RDS for SQL Server\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThis guide will show you how to create and connect to several types of database engines available in \u003ca href="https://aws.amazon.com/rds/"\u003eAmazon RDS\u003c/a\u003e through Kubernetes.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-rds"\u003eInstall the ACK service controller for RDS\u003c/h3\u003e\n\u003cp\u003eYou can deploy the ACK service controller for Amazon RDS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/rds-chart"\u003erds-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now use the Helm chart to deploy the ACK service controller for Amazon RDS to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the RDS API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the RDS API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/rds-chart --version=0.0.27 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the RDS API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003erds\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="deploy-database-instances"\u003eDeploy Database Instances\u003c/h2\u003e\n\u003cp\u003eYou can deploy most RDS database instances using the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The examples below show how to deploy using different database engines in RDS from your Kubernetes environment. For a full list of options available in the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource definition, you can use \u003ccode\u003ekubectl explain dbinstance\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe examples below use the \u003ccode\u003edb.t4g.micro\u003c/code\u003e instance type. Please review the \u003ca href="https://aws.amazon.com/rds/instance-types/"\u003eRDS instance types\u003c/a\u003e to select the most appropriate one for your workload.\u003c/p\u003e\n\u003ch3 id="postgresql"\u003ePostgreSQL\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/postgresql/"\u003eAWS RDS for PostgreSQL\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for PostgreSQL 14 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-postgresql.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: postgres\n engineVersion: \u0026quot;14\u0026quot;\n masterUsername: \u0026quot;postgres\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-postgresql.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch3 id="mysql"\u003eMySQL\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/mysql/"\u003eAWS RDS for MySQL\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for MySQL 8.0 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-mysql.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: mysql\n engineVersion: \u0026quot;8.0\u0026quot;\n masterUsername: \u0026quot;admin\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-mysql.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch3 id="mariadb"\u003eMariaDB\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/mariadb/"\u003eAWS RDS for MariaDB\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for MariaDB 10.6 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-mariadb.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: mariadb\n engineVersion: \u0026quot;10.6\u0026quot;\n masterUsername: \u0026quot;admin\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-mariadb.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database by describing the DBInstance custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch2 id="connect-to-database-instances"\u003eConnect to Database Instances\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eDBInstance\u003c/code\u003e status contains the information for connecting to a RDS database instance. The host information can be found in \u003ccode\u003estatus.endpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.endpoint.port\u003c/code\u003e. The master user name can be found in \u003ccode\u003espec.masterUsername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe database password is in the Secret that is referenced in the \u003ccode\u003eDBInstance\u003c/code\u003e spec (\u003ccode\u003espec.masterPassword.name\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. For example, to get the connection information from either RDS database instance created the above example, you can use the following example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_CONN_CM=\u0026quot;${RDS_INSTANCE_NAME}-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${RDS_INSTANCE_CONN_CM}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-host\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.address\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-port\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.port\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-user\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.spec.masterUsername\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\nEOF\n\nkubectl apply -f rds-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can inject these values into a container either as environmental variables or files. For example, here is a snippet of a Pod definition that will add the RDS instance connection info into the Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-pods.yaml\napiVersion: v1\nkind: Pod\nmetadata:\n name: app\n namespace: ${APP_NAMESPACE}\nspec:\n containers:\n - image: busybox\n name: myapp\n command:\n - sleep\n - \u0026quot;3600\u0026quot;\n imagePullPolicy: IfNotPresent\n env:\n - name: PGHOST\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-host\u0026quot;\n - name: PGPORT\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-port\u0026quot;\n - name: PGUSER\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-user\u0026quot;\n - name: PGPASSWORD\n valueFrom:\n secretKeyRef:\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-pods.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-a-database-from-snapshot"\u003eCreate a Database from Snapshot\u003c/h2\u003e\n\u003cp\u003eYou can also restore a database snapshot to a specific \u003ccode\u003eDBInstance\u003c/code\u003e or \u003ccode\u003eDBCluster\u003c/code\u003e using the ACK for RDS controller.\u003c/p\u003e\n\u003cp\u003eTo restore a database snapshot to a \u003ccode\u003eDBInstance\u003c/code\u003e, you must set the \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e parameter. \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e should match the identifier of an existing DBSnapshot.\u003c/p\u003e\n\u003cp\u003eTo restore a database snapshot to a \u003ccode\u003eDBCluster\u003c/code\u003e, you must set the \u003ccode\u003eSnapshotIdentifier\u003c/code\u003e. The value of \u003ccode\u003eSnapshotIdentifier\u003c/code\u003e should match either an existing \u003ccode\u003eDBCluster\u003c/code\u003e snapshot identifier or an ARN of a \u003ccode\u003eDBInstance\u003c/code\u003esnapshot.\u003c/p\u003e\n\u003cp\u003eOnce it\u0026rsquo;s set and the resource is created, updating \u003ccode\u003eSnapshotIdentifer\u003c/code\u003e or \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e fields will have no effect.\u003c/p\u003e\n\u003cp\u003eThe following examples show how you can restore database snapshots both to \u003ccode\u003eDBCluster\u003c/code\u003e and \u003ccode\u003eDBInstance\u003c/code\u003e resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_CLUSTER_NAME=\u0026quot;\u0026lt;your cluster name\u0026gt;\u0026quot;\nRDS_REGION=\u0026quot;\u0026lt;your aws region\u0026gt;\u0026quot;\nRDS_CUSTOMER_ACCOUNT=\u0026quot;\u0026lt;your aws account id\u0026gt;\u0026quot;\nRDS_DB_SNAPSHOT_IDENTIFIER=\u0026quot;\u0026lt;your db snapshot identifier\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-restore-dbcluster-snapshot.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBCluster\nmetadata:\n name: \u0026quot;${RDS_CLUSTER_NAME}\u0026quot;\nspec:\n dbClusterIdentifier: \u0026quot;${RDS_CLUSTER_NAME}\u0026quot;\n engine: aurora-postgresql\n engineVersion: \u0026quot;14\u0026quot;\n snapshotIdentifier: arn:aws:rds:${RDS_REGION}:${RDS_CUSTOMER_ACCOUNT}:snapshot:${RDS_DB_SNAPSHOT_IDENTIFIER}\nEOF\n\nkubectl apply -f rds-restore-dbcluster-snapshot.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\nRDS_DB_SNAPSHOT_IDENTIFIER=\u0026quot;\u0026lt;your db snapshot identifier\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-restore-dbinstance-snapshot.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.m5.large\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: postgres\n engineVersion: \u0026quot;14\u0026quot;\n masterUsername: \u0026quot;postgres\u0026quot;\n multiAZ: true\n dbSnapshotIdentifier: \u0026quot;${RDS_DB_SNAPSHOT_IDENTIFIER}\u0026quot;\nEOF\n\nkubectl apply -f rds-restore-dbinstance-snapshot.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eYou can learn more about each of the ACK service controller for RDS custom resources by using \u003ccode\u003ekubectl explain\u003c/code\u003e on the API resources. These include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbclusterparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbsecuritygroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eglobalclusters\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbproxy\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe ACK service controller for Amazon RDS is based on the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/"\u003eAmazon RDS API\u003c/a\u003e. To get a full understanding of how all of the APIs work, please review the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/"\u003eAmazon RDS API documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eYou can learn more about \u003ca href="https://docs.aws.amazon.com/rds/index.html"\u003ehow to use Amazon RDS\u003c/a\u003e through the \u003ca href="https://docs.aws.amazon.com/rds/index.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can deprovision your RDS instances using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the RDS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:20,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/ec2-example/",title:"Manage a VPC Workflow with the ACK EC2-Controller",description:"Create and manage a network topology using ACK EC2-Controller deployed on Amazon Elastic Kubernetes Service (EKS) The ACK service controller for Elastic Compute Cloud (EC2-Controller) lets users manage EC2 resources directly from Kubernetes. This guide demonstrates how to deploy a basic network topology (consisting of VPC resources) using a single Kubernetes resource manifest.",content:'\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Registry (Amazon ECR) with ACK, this guide assumes that you have\naccess to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster and Amazon ECR repository, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e and \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/get-set-up-for-amazon-ecr.html"\u003eAmazon ECR Setup\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eHave access to Amazon ECR\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/engine/install/"\u003eDocker\u003c/a\u003e - A tool to build, share, and run containers.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-ack-ec2-controller"\u003eInstall ACK EC2-Controller\u003c/h3\u003e\n\u003cp\u003eDeploy the EC2-Controller using the Helm chart, \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/ec2-chart"\u003eec2-chart\u003c/a\u003e. Note, this example creates resources in the \u003ccode\u003eus-west-2\u003c/code\u003e region, but you can use any other region supported in AWS.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall Helm chart:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=ec2\nexport AWS_REGION=\u0026lt;aws region id\u0026gt;\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/ec2-chart \u0026quot;--version=${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=${AWS_REGION}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the CRDs have been installed using \u003ccode\u003ekubectl get crds\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME CREATED AT\nadoptedresources.services.k8s.aws 2022-10-15T01:58:26Z\ndhcpoptions.ec2.services.k8s.aws 2022-10-15T01:58:26Z\nelasticipaddresses.ec2.services.k8s.aws 2022-10-15T01:58:26Z\neniconfigs.crd.k8s.amazonaws.com 2022-09-30T23:00:32Z\nfieldexports.services.k8s.aws 2022-10-15T01:58:26Z\ninstances.ec2.services.k8s.aws 2022-10-15T01:58:27Z\ninternetgateways.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nnatgateways.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nroutetables.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nsecuritygrouppolicies.vpcresources.k8s.aws 2022-09-30T23:00:35Z\nsecuritygroups.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nsubnets.ec2.services.k8s.aws 2022-10-15T01:58:28Z\ntransitgateways.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nvpcendpoints.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nvpcs.ec2.services.k8s.aws 2022-10-15T01:58:28Z\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values in the Helm chart, refer to \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/main/helm/values.yaml"\u003evalues.yaml\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eThe controller requires permissions to invoke EC2 APIs. Once the service controller is deployed \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e using the value \u003ccode\u003eSERVICE=ec2\u003c/code\u003e throughout. The recommended IAM Policy for EC2-Controller can be found in \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/main/config/iam/recommended-policy-arn"\u003erecommended-policy-arn\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="optional-create-a-vpc-and-subnet"\u003e[Optional] Create a VPC and Subnet\u003c/h3\u003e\n\u003cp\u003eThis section is optional and will NOT be using a single manifest file to deploy the VPC and Subnet. The purpose of this section is to demonstrate a simple use case to shed light on some of the functionality before jumping into a more complex deployment.\u003c/p\u003e\n\u003cp\u003eCreate the \u003cstrong\u003eVPC\u003c/strong\u003e using the provided YAML and \u003ccode\u003ekubectl apply\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; vpc.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: VPC\nmetadata:\n name: vpc-tutorial-test\nspec:\n cidrBlocks: \n - 10.0.0.0/16\n enableDNSSupport: true\n enableDNSHostnames: true\nEOF\n \nkubectl apply -f vpc.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the \u003cstrong\u003eVPC\u003c/strong\u003e \u003ccode\u003eStatus\u003c/code\u003e using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026gt; kubectl describe vpcs\n...\nStatus:\n Ack Resource Metadata:\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Cidr Block Association Set:\n Association ID: vpc-cidr-assoc-\u0026lt;ID\u0026gt;\n Cidr Block: 10.0.0.0/16\n Cidr Block State:\n State: associated\n Conditions:\n Last Transition Time: 2022-10-12T17:26:08Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Dhcp Options ID: dopt-\u0026lt;ID\u0026gt;\n Is Default: false\n Owner ID: \u0026lt;ID\u0026gt;\n State: available\n Vpc ID: vpc-\u0026lt;ID\u0026gt;\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003cstrong\u003eVPC\u003c/strong\u003e resource synced successfully and is available. Note the \u003ccode\u003evpc-\u0026lt;ID\u0026gt;\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eCreate the \u003cstrong\u003eSubnet\u003c/strong\u003e using \u003ccode\u003evpc-\u0026lt;ID\u0026gt;\u003c/code\u003e, the provided YAML, and \u003ccode\u003ekubectl apply\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; subnet.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: subnet-tutorial-test\nspec:\n cidrBlock: 10.0.0.0/20\n vpcID: vpc-\u0026lt;ID\u0026gt;\nEOF\n \nkubectl apply -f subnet.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the \u003cstrong\u003eSubnet\u003c/strong\u003e availability and ID using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026gt; kubectl describe subnets\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:ec2:us-west-2:\u0026lt;ID\u0026gt;:subnet/subnet-\u0026lt;ID\u0026gt;\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Available IP Address Count: 4091\n Conditions:\n Last Transition Time: 2022-10-12T17:36:53Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Default For AZ: false\n Map Customer Owned IP On Launch: false\n Owner ID: \u0026lt;ID\u0026gt;\n Private DNS Name Options On Launch:\n State: available\n Subnet ID: subnet-\u0026lt;ID\u0026gt;\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDelete the resources:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ekubectl delete -f subnet.yaml\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ekubectl delete -f vpc.yaml\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eBoth resources were successfully deployed, managed, then deleted by their respective controllers. Although contrived, this example highlights how easy it can be to deploy AWS resources via YAML files and how it feels like managing any other K8s resource.\u003c/p\u003e\n\u003cp\u003eIn this example, we used multiple YAML manifests and waited for the \u003ccode\u003evpcID\u003c/code\u003e to be generated before manually updating the Subnet custom resources to reference that VPC ID. This technique is less aligned to a fully declarative, GitOps-style of configuration management because dependencies between resources need to be manually resolved using a specific order of operations. The next example uses a single YAML manifest to deploy an entire network topology using ACK Resource References, a technique that better aligns with a fully automated and declarative GitOps-style of configuration management.\u003c/p\u003e\n\u003ch3 id="create-a-vpc-workflow"\u003eCreate a VPC Workflow\u003c/h3\u003e\n\u003cp\u003eIn this section, we create a network topology consisting of multiple, connected resources using a single YAML manifest. The following resources are present in this network topology:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e1 VPC\u003c/li\u003e\n\u003cli\u003e1 Instance\u003c/li\u003e\n\u003cli\u003e1 Internet Gateway\u003c/li\u003e\n\u003cli\u003e1 NAT Gateways\u003c/li\u003e\n\u003cli\u003e1 Elastic IPs\u003c/li\u003e\n\u003cli\u003e2 Route Tables\u003c/li\u003e\n\u003cli\u003e2 Subnets (1 Public; 1 Private)\u003c/li\u003e\n\u003cli\u003e1 Security Group\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003e\u003cimg src="../images/networktopology.png" alt="Network Topology"\u003e\u003c/p\u003e\n\u003cp\u003eThe VPC is connected to the Internet through an Internet Gateway. A NAT Gateway is created in the public Subnet with an associated Elastic IP. An Instance is deployed into the private Subnet which can connect to the Internet using the NAT Gateway in the public Subnet. Lastly, one Route Table (public) will contain a route to the Internet Gateway while the other Route Table (private) contains a route to the NAT Gateway.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNotice that the ACK custom resources reference each other using \u0026ldquo;*Ref\u0026rdquo; fields inside the manifest and the user does not have to worry about finding \u003ccode\u003evpc-ID\u003c/code\u003e when creating the Subnet resource manifests.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eEC2\u003c/em\u003e\nto find the supported reference fields.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNote, if the region used while installing the Helm chart is different from \u003ccode\u003eus-west-2\u003c/code\u003e, we need to modify availability zones and CIDR ranges in the provided YAML to match the needed region.\u003c/p\u003e\n\u003cp\u003eDeploy the resources using the provided YAML and \u003ccode\u003ekubectl apply -f vpc-workflow.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; vpc-workflow.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: VPC\nmetadata:\n name: tutorial-vpc\nspec:\n cidrBlocks: \n - 10.0.0.0/16\n enableDNSSupport: true\n enableDNSHostnames: true\n tags:\n - key: name\n value: vpc-tutorial\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: InternetGateway\nmetadata:\n name: tutorial-igw\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: NATGateway\nmetadata:\n name: tutorial-natgateway1\nspec:\n subnetRef:\n from:\n name: tutorial-public-subnet1\n allocationRef:\n from:\n name: tutorial-eip1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: ElasticIPAddress\nmetadata:\n name: tutorial-eip1\nspec:\n tags:\n - key: name\n value: eip-tutorial\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: RouteTable\nmetadata:\n name: tutorial-public-route-table\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n routes:\n - destinationCIDRBlock: 0.0.0.0/0\n gatewayRef:\n from:\n name: tutorial-igw\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: RouteTable\nmetadata:\n name: tutorial-private-route-table-az1\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n routes:\n - destinationCIDRBlock: 0.0.0.0/0\n natGatewayRef:\n from:\n name: tutorial-natgateway1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: tutorial-public-subnet1\nspec:\n availabilityZone: us-west-2a\n cidrBlock: 10.0.0.0/20\n mapPublicIPOnLaunch: true\n vpcRef:\n from:\n name: tutorial-vpc\n routeTableRefs:\n - from:\n name: tutorial-public-route-table\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: tutorial-private-subnet1\nspec:\n availabilityZone: us-west-2a\n cidrBlock: 10.0.128.0/20\n vpcRef:\n from:\n name: tutorial-vpc\n routeTableRefs:\n - from:\n name: tutorial-private-route-table-az1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: SecurityGroup\nmetadata:\n name: tutorial-security-group\nspec:\n description: \u0026quot;ack security group\u0026quot;\n name: tutorial-sg\n vpcRef:\n from:\n name: tutorial-vpc\n ingressRules:\n - ipProtocol: tcp\n fromPort: 22\n toPort: 22\n ipRanges:\n - cidrIP: \u0026quot;0.0.0.0/0\u0026quot;\n description: \u0026quot;ingress\u0026quot;\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output should look similar to:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003evpc.ec2.services.k8s.aws/tutorial-vpc created\ninternetgateway.ec2.services.k8s.aws/tutorial-igw created\nnatgateway.ec2.services.k8s.aws/tutorial-natgateway1 created\nelasticipaddress.ec2.services.k8s.aws/tutorial-eip1 created\nroutetable.ec2.services.k8s.aws/tutorial-public-route-table created\nroutetable.ec2.services.k8s.aws/tutorial-private-route-table-az1 created\nsubnet.ec2.services.k8s.aws/tutorial-public-subnet1 created\nsubnet.ec2.services.k8s.aws/tutorial-private-subnet1 created\nsecuritygroup.ec2.services.k8s.aws/tutorial-security-group created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the resources you just created using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ekubectl describe vpcs\nkubectl describe internetgateways\nkubectl describe routetables\nkubectl describe natgateways\nkubectl describe elasticipaddresses\nkubectl describe subnets\nkubectl describe securitygroups\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote that Subnet gets into an \u0026lsquo;available\u0026rsquo; state with a \u003ccode\u003eACK.ReferencesResolved = True\u003c/code\u003e condition attached notifying users that the references (VPC, RouteTable) have been found and resolved:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eStatus:\n Ack Resource Metadata:\n Arn: arn:aws:ec2:us-west-2:\u0026lt;ID\u0026gt;:subnet/subnet-0ba22f5820bb41584\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Available IP Address Count: 4091\n Conditions:\n Last Transition Time: 2022-10-13T14:54:39Z\n Status: True\n Type: ACK.ReferencesResolved\n Last Transition Time: 2022-10-13T14:54:41Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Default For AZ: false\n Map Customer Owned IP On Launch: false\n Owner ID: 515336597380\n Private DNS Name Options On Launch:\n State: available\n Subnet ID: subnet-\u0026lt;ID\u0026gt;\n \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="validate"\u003eValidate\u003c/h3\u003e\n\u003cp\u003eThis network setup should allow Instances deployed in the Private Subnet to connect to the Internet. To validate this behavior, deploy an Instance into the private Subnet and the public Subnet (bastion host). After waiting until the Instances are in an \u003ccode\u003eavailable\u003c/code\u003e state, \u003ccode\u003essh\u003c/code\u003e into the bastion host, then \u003ccode\u003essh\u003c/code\u003e into the private Subnet Instance, and test internet connectivity. A SecurityGroup is required by both instances launched in the public and private Subnets.\u003c/p\u003e\n\u003cp\u003eNote, we need to provide Subnet and SecurityGroup ID\u0026rsquo;s in the yaml manually; run \u003ccode\u003ekubectl describe subnets\u003c/code\u003e and \u003ccode\u003ekubectl describe securitygroups\u003c/code\u003e commands to get ID\u0026rsquo;s. We need to create key-pair via console and provide in yaml to launch instances.\u003c/p\u003e\n\u003cp\u003eDeploy an Instance into the Private Subnet using provided YAML and \u003ccode\u003ekubectl apply -f tutorial-instance-private.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; tutorial-instance-private.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Instance\nmetadata:\n name: tutorial-instance-private\nspec:\n imageID: ami-02b92c281a4d3dc79 # AL2; us-west-2\n instanceType: c3.large\n subnetID: subnet-\u0026lt;private-ID\u0026gt;\n securityGroupIDs:\n - sg-\u0026lt;ID\u0026gt;\n keyName: us-west-2-key # created via console\n tags:\n - key: producer\n value: ack\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the bastion host Instance into the Public Subnet using provided YAML and \u003ccode\u003ekubectl apply -f tutorial-bastion-host.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; tutorial-bastion-host.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Instance\nmetadata:\n name: tutorial-bastion-host\nspec:\n imageID: ami-02b92c281a4d3dc79 # AL2 in us-west-2\n instanceType: c3.large\n subnetID: subnet-\u0026lt;public-ID\u0026gt;\n securityGroupIDs:\n - sg-\u0026lt;ID\u0026gt;\n keyName: us-west-2-key # created via console\n tags:\n - key: producer\n value: ack\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eValidate if the instances are created successfully with \u003ccode\u003ekubectl describe instances\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eIf you see following type of error in the output of above command, then find one of the available instance types for your Region and Availability zone and replace in the above YAML files\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eMessage: Unsupported: Your requested instance type (c3.large) is not supported in your requested Availability Zone (us-west-2a). Please retry your request by not specifying an Availability Zone or choosing us-west-2b, us-west-2c, us-west-2d, us-west-2e.\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can use below command to find EC2 instance types supported in your AWS region and availability zone (for example, to check if c5.large is supported in us-west-2 region and us-west-2a availability zone):\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eaws ec2 describe-instance-type-offerings --location-type \u0026quot;availability-zone\u0026quot; --filters Name=location,Values=us-west-2a --region us-west-2 --query \u0026quot;InstanceTypeOfferings[*].[InstanceType]\u0026quot; --output text | sort | grep c5.large\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFind out IDs of the instances in public and private subnets by running this command \u003ccode\u003ekubectl get instances\u003c/code\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME ID\ntutorial-instance-private *i-xxxxxxxxxxxxxxxx*\ntutorial-bastion-host *i-xxxxxxxxxxxxxxxx*\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote, we need to get \u003ccode\u003ePublic IPV4 DNS\u003c/code\u003e for bastion host instance from EC2 console and substitute in the below commands. We can get the \u003ccode\u003ePrivate IP\u003c/code\u003e for private instance on running \u003ccode\u003ekubectl describe instance tutorial-instance-private\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eDeployed 2 instances; one to each Subnet\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe instance in the public subnet will be the bastion host so we can ssh to the Instance in the private Subnet\n\u003cpre\u003e\u003ccode class="language-bash"\u003escp -i \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Public IPV4 DNS\u0026gt;:\nssh -i \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Public IPV4 DNS\u0026gt;\nssh -i \u0026quot;created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Private IP\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eValidate instance in private subnet can connect to internet\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eTry to ping websites from your private subnet, sample output looks like\n\u003cpre\u003e\u003ccode class="language-bash"\u003eping google.com\n\nPING google.com (142.250.217.78) 56(84) bytes of data.\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=1 ttl=102 time=8.30 ms\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=2 ttl=102 time=7.82 ms\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=3 ttl=102 time=7.77 ms\n^C\n--- google.com ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 2003ms\n\u003c/code\u003e\u003c/pre\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resources using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f tutorial-bastion-host.yaml\nkubectl delete -f tutorial-instance-private.yaml\nkubectl delete -f vpc-workflow.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote, deleting resources can take a few minutes as we have couple of resources created using a single manifest, do not kill the \u003ccode\u003ekubectl delete\u003c/code\u003e command, wait until it finishes completely.\u003c/p\u003e\n\u003cp\u003eThe output of delete commands should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003einstance.ec2.services.k8s.aws \u0026quot;tutorial-bastion-host\u0026quot; deleted\ninstance.ec2.services.k8s.aws \u0026quot;tutorial-instance-private\u0026quot; deleted\nvpc.ec2.services.k8s.aws/tutorial-vpc deleted\ninternetgateway.ec2.services.k8s.aws/tutorial-igw deleted\nnatgateway.ec2.services.k8s.aws/tutorial-natgateway1 deleted\nelasticipaddress.ec2.services.k8s.aws/tutorial-eip1 deleted\nroutetable.ec2.services.k8s.aws/tutorial-public-route-table deleted\nroutetable.ec2.services.k8s.aws/tutorial-private-route-table-az1 deleted\nsubnet.ec2.services.k8s.aws/tutorial-public-subnet1 deleted\nsubnet.ec2.services.k8s.aws/tutorial-private-subnet1 deleted\nsecuritygroup.ec2.services.k8s.aws/tutorial-security-group deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the EC2 ACK service controller, related CRDs, and namespaces, see \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:21,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/apigatewayv2-reference-example/",title:"Manage HTTP APIs with the ACK APIGatewayv2 Controller",description:"Create and Invoke an Amazon APIGateway HTTP API using ACK APIGatewayv2 controller deployed on Amazon Elastic Kubernetes Service (EKS).",content:'\u003cp\u003eThe ACK service controller for Amazon APIGatewayv2 lets you manage HTTP APIs and VPC Links directly from Kubernetes.\nThis guide will show you how to create and invoke an HTTP API using a single Kubernetes resource manifest.\u003c/p\u003e\n\u003cp\u003eIn this tutorial we will invoke a single public endpoint by fronting it with an \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html"\u003eHTTP API\u003c/a\u003e. We create a\n\u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html"\u003eRoute\u003c/a\u003e with \u003ccode\u003eGET\u003c/code\u003e HTTP method and an \u003ccode\u003eHTTP_PROXY\u003c/code\u003e \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html"\u003eIntegration\u003c/a\u003e forwarding\ntraffic to the public endpoint. We also create an auto-deployable \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html"\u003eStage\u003c/a\u003e which will deploy the HTTP\nAPI and make it invokable.\u003c/p\u003e\n\u003cp\u003eTo invoke many endpoints using the single HTTP API, add multiple \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html"\u003eRoutes\u003c/a\u003e and\n\u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html"\u003eIntegrations\u003c/a\u003e to the same API.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see\n\u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see\n\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-apigatewayv2"\u003eInstall the ACK service controller for APIGatewayv2\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon APIGatewayv2 using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/apigatewayv2-chart"\u003eapigatewayv2-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/apigatewayv2-chart --version=0.0.17 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to invoke the APIGatewayv2 API. For full details, please review the AWS Controllers for Kubernetes documentation\nfor \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the\nvalue of \u003ccode\u003eapigatewayv2\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-http-api"\u003eCreate HTTP API\u003c/h2\u003e\n\u003cp\u003eExecute the following command to create a manifest containing all the APIGatewayv2 custom resources and submit this\nmanifest to EKS cluster using kubectl.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNotice that the ACK custom resources reference each other using \u0026ldquo;*Ref\u0026rdquo; fields inside the manifest and the user does not\nhave to worry about finding APIID, IntegrationID when creating the K8s resource manifests.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eAPIGatewayv2\u003c/em\u003e\nto find the supported reference fields.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAPI_NAME=\u0026quot;ack-api\u0026quot;\nINTEGRATION_NAME=\u0026quot;ack-integration\u0026quot;\nINTEGRATION_URI=\u0026quot;https://httpbin.org/get\u0026quot;\nROUTE_NAME=\u0026quot;ack-route\u0026quot;\nROUTE_KEY_NAME=\u0026quot;ack-route-key\u0026quot;\nSTAGE_NAME=\u0026quot;ack-stage\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; apigwv2-httpapi.yaml\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: API\nmetadata:\n name: \u0026quot;${API_NAME}\u0026quot;\nspec:\n name: \u0026quot;${API_NAME}\u0026quot;\n protocolType: HTTP\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Integration\nmetadata:\n name: \u0026quot;${INTEGRATION_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n integrationType: HTTP_PROXY\n integrationURI: \u0026quot;${INTEGRATION_URI}\u0026quot;\n integrationMethod: GET\n payloadFormatVersion: \u0026quot;1.0\u0026quot;\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Route\nmetadata:\n name: \u0026quot;${ROUTE_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n routeKey: \u0026quot;GET /${ROUTE_KEY_NAME}\u0026quot;\n targetRef:\n from:\n name: \u0026quot;${INTEGRATION_NAME}\u0026quot;\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Stage\nmetadata:\n name: \u0026quot;${STAGE_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n stageName: \u0026quot;${STAGE_NAME}\u0026quot;\n autoDeploy: true\n description: \u0026quot;auto deployed stage for ${API_NAME}\u0026quot;\nEOF\n\nkubectl apply -f apigwv2-httpapi.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe manifest contains 4 APIGatewayv2 custom resources: API, Integration, Route and Stage.\nWhen this manifest is submitted using \u003cem\u003ekubectl\u003c/em\u003e, it creates corresponding 4 custom resources in the EKS cluster.\u003c/p\u003e\n\u003cp\u003eThe output of above command looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eapi.apigatewayv2.services.k8s.aws/ack-api created\nintegration.apigatewayv2.services.k8s.aws/ack-integration created\nroute.apigatewayv2.services.k8s.aws/ack-route created\nstage.apigatewayv2.services.k8s.aws/ack-stage created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="describe-custom-resources"\u003eDescribe Custom Resources\u003c/h2\u003e\n\u003cp\u003eView these custom resources using following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe api/\u0026quot;${API_NAME}\u0026quot;\nkubectl describe integration/\u0026quot;${INTEGRATION_NAME}\u0026quot;\nkubectl describe route/\u0026quot;${ROUTE_NAME}\u0026quot;\nkubectl describe stage/\u0026quot;${STAGE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eOutput of describing \u003cem\u003eRoute\u003c/em\u003e resource looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: ack-route\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: apigatewayv2.services.k8s.aws/v1alpha1\nKind: Route\nMetadata:\n Creation Timestamp: 2022-03-08T18:13:16Z\n Finalizers:\n finalizers.apigatewayv2.services.k8s.aws/Route\n Generation: 2\n Resource Version: 116729769\n UID: 0286a10e-0389-4ea8-90ae-890946d5d280\nSpec:\n API Key Required: false\n API Ref:\n From:\n Name: ack-api\n Authorization Type: NONE\n Route Key: GET /ack-route-key\n Target Ref:\n From:\n Name: ack-integration\nStatus:\n Ack Resource Metadata:\n Owner Account ID: ***********\n Conditions:\n Last Transition Time: 2022-03-08T18:13:23Z\n Status: True\n Type: ACK.ReferencesResolved\n Last Transition Time: 2022-03-08T18:13:23Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Route ID: *****\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK controller reads the referenced resources and determines the identifiers, like APIID, from the referenced\nresources. Find the \u003cem\u003eACK.ReferencesResolved\u003c/em\u003e condition inside the \u003cem\u003eStatus\u003c/em\u003e of Route, Integration and Stage\nresources to see the progress of reference resolution.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="invoke-http-api"\u003eInvoke HTTP API\u003c/h2\u003e\n\u003cp\u003eExecute the following command to invoke the HTTP API\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecurl $(kubectl get api/\u0026quot;${API_NAME}\u0026quot; -o=jsonpath=\'{.status.apiEndpoint}\')/\u0026quot;${STAGE_NAME}\u0026quot;/\u0026quot;${ROUTE_KEY_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe above commands finds the invocation endpoint from the \u003cem\u003eApi\u003c/em\u003e custom resource and appends the required \u003cem\u003eStage\u003c/em\u003e name,\n\u003cem\u003eRoute Key\u003c/em\u003e to the url before invoking.\u003c/p\u003e\n\u003cp\u003eThe output should look similar to\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;args\u0026quot;: {},\n \u0026quot;headers\u0026quot;: {\n \u0026quot;Accept\u0026quot;: \u0026quot;*/*\u0026quot;,\n \u0026quot;Content-Length\u0026quot;: \u0026quot;0\u0026quot;,\n \u0026quot;Forwarded\u0026quot;: \u0026quot;by=****;for=****;host=******.execute-api.us-west-2.amazonaws.com;proto=https\u0026quot;,\n \u0026quot;Host\u0026quot;: \u0026quot;httpbin.org\u0026quot;,\n \u0026quot;User-Agent\u0026quot;: \u0026quot;curl/7.64.1\u0026quot;,\n \u0026quot;X-Amzn-Trace-Id\u0026quot;: \u0026quot;Self=****;Root=****\u0026quot;\n },\n \u0026quot;origin\u0026quot;: \u0026quot;****\u0026quot;,\n \u0026quot;url\u0026quot;: \u0026quot;https://httpbin.org/get\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon APIGatewayv2 is based on the \u003ca href="https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/api-reference.html"\u003eAmazon APIGatewayv2 API\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eAPiGatewayv2\u003c/em\u003e to find\nall the supported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cul\u003e\n\u003cli\u003eCurrently ACK service controller for APIGatewayv2 only supports HTTP APIs.\u003c/li\u003e\n\u003cli\u003eWebSocket API support will be added in future releases.\u003c/li\u003e\n\u003cli\u003eSupport for DomainName and APIMapping will also be added in future releases.\u003c/li\u003e\n\u003c/ul\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f apigwv2-httpapi.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eapi.apigatewayv2.services.k8s.aws \u0026quot;ack-api\u0026quot; deleted\nintegration.apigatewayv2.services.k8s.aws \u0026quot;ack-integration\u0026quot; deleted\nroute.apigatewayv2.services.k8s.aws \u0026quot;ack-route\u0026quot; deleted\nstage.apigatewayv2.services.k8s.aws \u0026quot;ack-stage\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the APIGatewayv2 ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:22,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/memorydb-example/",title:"Create a managed Amazon MemoryDB for Redis Cluster using the ACK MemoryDB Controller",description:"Create a managed Amazon MemoryDB for Redis Cluster using the memorydb-controller",content:'\u003cp\u003eThe ACK service controller for Amazon MemoryDB for Redis lets you manage Amazon MemoryDB Cluster directly from Kubernetes.\nThis guide will show you how to create a \u003ca href="https://aws.amazon.com/memorydb/"\u003eAmazon MemoryDB for Redis\u003c/a\u003e Cluster using Kubernetes resource manifest.\u003c/p\u003e\n\u003cp\u003eIn this tutorial we will install ACK service controller for Amazon MemoryDB for Redis on an Amazon EKS Cluster. We configure IAM permissions for the controller to invoke Amazon MemoryDB API. We create Amazon MemoryDB Cluster instances. We also deploy a sample POD on the Amazon EKS Cluster to connect to the Amazon MemoryDB Cluster instance from the POD.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes. If you follow this document, install AWS CLI first. Use \u003ccode\u003eaws configure\u003c/code\u003e to access IAM permissions before creating EKS cluster.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.18 or higher.\u003c/li\u003e\n\u003cli\u003eSetup the \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html"\u003eAmazon VPC Container Network Interface (CNI) plugin for Kubernetes\u003c/a\u003e for the EKS Cluster.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-amazon-memorydb"\u003eInstall the ACK service controller for Amazon MemoryDB\u003c/h3\u003e\n\u003cp\u003eYou can deploy the ACK service controller for Amazon MemoryDB using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/memorydb-chart"\u003ememorydb-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can install the Helm chart to deploy the ACK service controller for Amazon MemoryDB to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the Amazon MemoryDB API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the Amazon MemoryDB API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can find the latest version of ACK MemoryDB controller on GitHub \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/releases"\u003erelease page\u003c/a\u003e.\nReplace value for \u003ccode\u003e--version\u003c/code\u003e to the desired version.\u003c/p\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the Amazon MemoryDB API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003ememorydb\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e. Install wget, \u003ca href="https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli"\u003eoc\u003c/a\u003e, \u003ca href="https://github.com/stedolan/jq/wiki/Installation"\u003ejq\u003c/a\u003e, sed first. Skip Next Steps in the documentation.\u003c/p\u003e\n\u003ch2 id="create-amazon-memorydb-cluster-instances"\u003eCreate Amazon MemoryDB Cluster Instances\u003c/h2\u003e\n\u003cp\u003eYou can create Amazon MemoryDB Clusters using the \u003ccode\u003eCluster\u003c/code\u003e custom resource. The examples below show how to deploy it from your Kubernetes environment. For a full list of options available in the \u003ccode\u003eCluster\u003c/code\u003e custom resource definition, you can use \u003ccode\u003ekubectl explain cluster\u003c/code\u003e command.\u003c/p\u003e\n\u003ch3 id="amazon-memorydb-cluster"\u003eAmazon MemoryDB Cluster\u003c/h3\u003e\n\u003cp\u003eTo create a Amazon MemoryDB Cluster, create a \u003ccode\u003eCluster\u003c/code\u003e custom resource. The examples below shows how to provision a Amazon MemoryDB Cluster :\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe first example creates a Amazon MemoryDB Cluster in default VPC\u003c/li\u003e\n\u003cli\u003eThe second example creates a Amazon MemoryDB Cluster in specific VPC subnets and security groups.\nYou may choose any option from these examples. You can check more \u003ca href="https://github.com/aws-controllers-k8s/examples/tree/main/resources/memorydb/v1alpha1"\u003eyaml examples\u003c/a\u003e of all MemoryDB resources.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch4 id="create-amazon-memorydb-cluster-in-default-vpc"\u003eCreate Amazon MemoryDB Cluster in default VPC\u003c/h4\u003e\n\u003cp\u003eThe following YAML creates a MemoryDB Cluster using the default VPC subnets and security group.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-cluster.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: Cluster\nmetadata:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n nodeType: db.t4g.small\n aclName: open-access\nEOF\n\nkubectl apply -f memorydb-cluster.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-amazon-memorydb-cluster-in-specific-vpc-subnets-and-security-groups"\u003eCreate Amazon MemoryDB Cluster in specific VPC subnets and security groups\u003c/h4\u003e\n\u003cp\u003eTo create a Amazon MemoryDB Cluster using specific subnets from a VPC, create a MemoryDB \u003ccode\u003eSubnectGroup\u003c/code\u003e custom resource first and then specify it, and a security group name, in the \u003ccode\u003eCluster\u003c/code\u003e specification.\u003c/p\u003e\n\u003ch5 id="create-amazon-memorydb-subnet-group"\u003eCreate Amazon MemoryDB subnet group\u003c/h5\u003e\n\u003cp\u003eThe following example uses the VPC ID of the EKS Cluster. You may specify any other VPC ID by updating the \u003ccode\u003eVPC_ID\u003c/code\u003e variable in the following example.\nReplace \u003ccode\u003eEKS_CLUSTER_NAME\u003c/code\u003e to the eks cluster name you created under \u0026lsquo;Prerequisites\u0026rsquo; section.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eEKS_CLUSTER_NAME=\u0026quot;example-eks-cluster\u0026quot;\nAWS_REGION=\u0026quot;us-east-1\u0026quot;\nVPC_ID=$(aws --region $AWS_REGION eks describe-cluster --name $EKS_CLUSTER_NAME --query cluster.resourcesVpcConfig.vpcId)\nSUBNET_IDS=$(aws --region $AWS_REGION ec2 describe-subnets \\\n --filters \u0026quot;Name=vpc-id,Values=${VPC_ID}\u0026quot; \\\n --query \'Subnets[*].SubnetId\' \\\n --output text\n)\n\nMEMORYDB_SUBNETGROUP_NAME=\u0026quot;example-subnet-group\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-subnetgroup.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: SubnetGroup\nmetadata:\n name: \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\n description: \u0026quot;MemoryDB cluster subnet group\u0026quot;\n subnetIDs:\n$(printf \u0026quot; - %s\\n\u0026quot; ${SUBNET_IDS})\n\nEOF\n\nkubectl apply -f memorydb-subnetgroup.yaml\nkubectl describe subnetgroup \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf you observe that the \u003ccode\u003eACK.Terminal\u003c/code\u003e condition is set for the SubnetGroup and the error is similar to the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eStatus:\n Conditions:\n Message: SubnetNotAllowedFault: Subnets: [subnet-1d111111, subnet-27d22222] are not in a supported availability zone. Supported availability zones are [us-east-1c, us-east-1d, us-east-1b].\n Status: True\n Type: ACK.Terminal\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen update the \u003ccode\u003esubnetIDs\u003c/code\u003e in the input YAML and provide the subnet Ids that are in a supported availability zone.\u003c/p\u003e\n\u003ch5 id="create-amazon-memorydb-cluster"\u003eCreate Amazon MemoryDB Cluster\u003c/h5\u003e\n\u003cp\u003eThe following example uses the MemoryDB subnet group created above. It uses the provisioning EKS Cluster\u0026rsquo;s security group. You may specify any other VPC security group by modifying the list of \u003ccode\u003esecurityGroupIDs\u003c/code\u003e in the specification.\nIt uses the \u003ccode\u003edb.t4g.small\u003c/code\u003e node type for the MemoryDB cluster. Please review the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html"\u003eMemoryDB node types\u003c/a\u003e to select the most appropriate one for your workload.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eEKS_CLUSTER_NAME=\u0026quot;example-eks-cluster\u0026quot;\nMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\nAWS_REGION=\u0026quot;us-east-1\u0026quot;\nSECURITY_GROUP_ID=$(aws --region $AWS_REGION eks describe-cluster --name $EKS_CLUSTER_NAME --query cluster.resourcesVpcConfig.clusterSecurityGroupId)\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-cluster.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: Cluster\nmetadata:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n nodeType: db.t4g.small\n aclName: open-access\n securityGroupIDs:\n - ${SECURITY_GROUP_ID}\n subnetGroupName: ${MEMORYDB_SUBNETGROUP_NAME}\nEOF\n\nkubectl apply -f memorydb-cluster.yaml\nkubectl describe cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eCluster\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of the \u003cem\u003eCluster\u003c/em\u003e resource looks like:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: clusters\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: memorydb.services.k8s.aws/last-requested-node-type: db.t4g.medium\n memorydb.services.k8s.aws/last-requested-num-shards: 2\nAPI Version: memorydb.services.k8s.aws/v1alpha1\nKind: Cluster\nMetadata:\n Creation Timestamp: 2022-03-30T08:47:07Z\n Finalizers:\n finalizers.memorydb.services.k8s.aws/Cluster\n Generation: 5\n Resource Version: 158132376\n Self Link: /apis/memorydb.services.k8s.aws/v1alpha1/namespaces/default/clusters/clusters\n UID: 2f6fc7ed-fe04-42cb-85bf-b7982dedec1c\nSpec:\n Acl Name: open-access\n Auto Minor Version Upgrade: true\n Engine Version: 6.2\n Maintenance Window: sat:03:00-sat:04:00\n Name: clusters\n Node Type: db.t4g.medium\n Num Replicas Per Shard: 1\n Num Shards: 2\n Parameter Group Name: default.memorydb-redis6\n Snapshot Retention Limit: 0\n Snapshot Window: 05:30-06:30\n Subnet Group Name: default\n Tls Enabled: true\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:memorydb:us-east-1:************:cluster/clusters\n Owner Account ID: ************\n Allowed Scale Down Node Types:\n db.t4g.small\n Allowed Scale Up Node Types:\n db.r6g.12xlarge\n db.r6g.16xlarge\n db.r6g.2xlarge\n db.r6g.4xlarge\n db.r6g.8xlarge\n db.r6g.large\n db.r6g.xlarge\n Cluster Endpoint:\n Address: clustercfg.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Conditions:\n Last Transition Time: 2022-04-06T22:05:25Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Engine Patch Version: 6.2.4\n Number Of Shards: 2\n Parameter Group Status: in-sync\n Shards:\n Name: 0001\n Nodes:\n Availability Zone: us-east-1d\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0001-001.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0001-001\n Status: available\n Availability Zone: us-east-1b\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0001-002.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0001-002\n Status: available\n Number Of Nodes: 2\n Slots: 0-8191\n Status: available\n Name: 0002\n Nodes:\n Availability Zone: us-east-1c\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0002-001.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0002-001\n Status: available\n Availability Zone: us-east-1d\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0002-002.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0002-002\n Status: available\n Number Of Nodes: 2\n Slots: 8192-16383\n Status: available\n Status: available\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eCluster Status\u003c/code\u003e says \u003ccode\u003eavailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch2 id="connect-to-amazon-memorydb-cluster"\u003eConnect to Amazon MemoryDB Cluster\u003c/h2\u003e\n\u003cblockquote\u003e\n\u003cp\u003eTo connect to the MemoryDB Cluster from a Pod running inside Kubernetes cluster:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eEnsure that the \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html"\u003eAmazon VPC Container Network Interface (CNI) plugin for Kubernetes\u003c/a\u003e has been setup for the EKS Cluster.\u003c/li\u003e\n\u003cli\u003eReview \u003ca href="https://docs.aws.amazon.com/memorydb/latest/devguide/memorydb-vpc-accessing.html"\u003eaccess patterns for accessing a MemoryDB Cluster in an Amazon VPC\u003c/a\u003e to confirm that MemoryDB cluster is configured to allow connection from the Pod.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eThe \u003ccode\u003eCluster\u003c/code\u003e status contains the information for connecting to a Amazon MemoryDB for Redis Cluster. The host information can be found in \u003ccode\u003estatus.clusterEndpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.clusterEndpoint.port\u003c/code\u003e. For example, you can get the connection information for a \u003ccode\u003eCluster\u003c/code\u003e created in one of the previous examples using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot; -o jsonpath=\'{.status.clusterEndpoint.address}\'\nkubectl get cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot; -o jsonpath=\'{.status.clusterEndpoint.port}\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. The following example makes the MemoryDB cluster endpoint and port available as ConfigMap data:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\nMEMORYDB_CLUSTER_CONN_CM=\u0026quot;${MEMORYDB_CLUSTER_NAME}-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${MEMORYDB_CLUSTER_NAME}-host\nspec:\n to:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.clusterEndpoint.address\u0026quot;\n resource:\n group: memorydb.services.k8s.aws\n kind: Cluster\n name: ${MEMORYDB_CLUSTER_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${MEMORYDB_CLUSTER_NAME}-port\nspec:\n to:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.clusterEndpoint.port\u0026quot;\n resource:\n group: memorydb.services.k8s.aws\n kind: Cluster\n name: ${MEMORYDB_CLUSTER_NAME}\nEOF\n\nkubectl apply -f memorydb-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eConfirm that the Amazon MemoryDB endpoint details are available in the config map by running the following command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ekubectl get configmap/${MEMORYDB_CLUSTER_CONN_CM} -o jsonpath=\'{.data}\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThese values can be injected into a container either as environmental variables or files. For example, here is a snippet of a deployment definition that will add the Amazon MemoryDB Cluster connection info into a Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; game_leaderboard.yaml\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: leaderboard-deployment\n labels:\n app: leaderboard\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: leaderboard\n template:\n metadata:\n labels:\n app: leaderboard\n spec:\n containers:\n - name: leaderboard\n image: public.ecr.aws/sam/build-python3.8:latest\n tty: true\n stdin: true\n env:\n - name: MEMORYDB_CLUSTER_HOST\n valueFrom:\n configMapKeyRef:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n key: \u0026quot;${MEMORYDB_CLUSTER_NAME}-host\u0026quot;\n - name: MEMORYDB_CLUSTER_PORT\n valueFrom:\n configMapKeyRef:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n key: \u0026quot;${MEMORYDB_CLUSTER_NAME}-port\u0026quot;\nEOF\n\nkubectl apply -f game_leaderboard.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eConfirm that the leaderboard application container has been deployed successfully by running the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ekubectl get pods –selector=app=leaderboard\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the Pod Status is \u003ccode\u003eRunning\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eGet a shell to the running leaderboard container.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eLEADERBOARD_POD_NAME=$(kubectl get pods –selector=app=leaderboard -o jsonpath=\'{.items[*].metadata.name}\')\nkubectl exec –stdin –tty ${LEADERBOARD_POD_NAME} -- /bin/bash\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the running leaderboard container shell, run the following commands and confirm that the MemoryDB cluster host and port are available as environment variables.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003e# Confirm that the memorydb cluster host, port are available as environment variables\necho $MEMORYDB_CLUSTER_HOST\necho $MEMORYDB_CLUSTER_PORT\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eYou can learn more about each of the ACK service controller for Amazon MemoryDB custom resources by using \u003ccode\u003ekubectl explain\u003c/code\u003e on the API resources. These include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eacl\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esubnetgroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe ACK service controller for Amazon MemoryDB is based on the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/APIReference/Welcome.html"\u003eAmazon MemoryDB API\u003c/a\u003e. To get a full understanding of how all the APIs work, please review the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/APIReference/Welcome.html"\u003eAmazon MemoryDB API documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eYou can learn more about \u003ca href="https://docs.aws.amazon.com/memorydb/index.html"\u003ehow to use Amazon MemoryDB\u003c/a\u003e through the \u003ca href="https://docs.aws.amazon.com/memorydb/index.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can deprovision your Amazon MemoryDB for Redis Cluster using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cp\u003eFollowing commands delete the resources that were created in this tutorial.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f game_leaderboard.yaml\nkubectl delete -f memorydb-field-exports.yaml\nkubectl delete -f memorydb-cluster.yaml\nkubectl delete -f memorydb-subnetgroup.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the MemoryDB ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:23,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/aurora-serverless-v2/",title:"Manage an Aurora Serverless v2 cluster with the ACK RDS Controller",description:"Create an Aurora Serverless v2 cluster from an Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eAurora Serverless v2 introduces the ability to automatically and instantly scale\ndatabase capacity for Aurora MySQL-compatiable and Aurora PostgreSQL-compatible\nclusters. Scaling uses fine-grained increments called Aurora capacity units\n(ACUs) that incrementally scale up and down over smaller units (e.g. 0.5, 1,\n1.5, 2) instead of doubling on each scaling operation (e.g. 16 =\u0026gt; 32).\nAurora Serverless v2 helps applications with variable workloads or multitenancy\nto only use the resources they need and manage costs, instead of having to\nprovision for a peak workload.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage\n\u003ca href="https://aws.amazon.com/rds/aurora/serverless/"\u003eAurora Serverless v2\u003c/a\u003e instances\nfrom an Amazon Elastic Kubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eThis tutorial uses \u003ca href="https://www.eksworkshop.com/010_introduction/"\u003eAmazon EKS Workshop\u003c/a\u003e to deploy EKS cluster.\u003c/p\u003e\n\u003ch3 id="set-up-amazon-eks-workshop"\u003eSet up Amazon EKS Workshop\u003c/h3\u003e\n\u003col\u003e\n\u003cli\u003eCreate a \u003ca href="https://www.eksworkshop.com/020_prerequisites/workspace/"\u003eworkspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eInstall the \u003ca href="https://www.eksworkshop.com/020_prerequisites/k8stools/"\u003eKubernetes tools\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCreate an \u003ca href="https://www.eksworkshop.com/020_prerequisites/iamrole/"\u003eIAM role for workspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eAttach \u003ca href="https://www.eksworkshop.com/020_prerequisites/ec2instance/"\u003eIAM role to workspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eUpdate \u003ca href="https://www.eksworkshop.com/020_prerequisites/workspaceiam/"\u003eIAM settings\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://www.eksworkshop.com/020_prerequisites/kmskey/"\u003eCreate KMS customer managed keys\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch3 id="deploy-an-amazon-eks-cluster"\u003eDeploy an Amazon EKS cluster\u003c/h3\u003e\n\u003col start="2"\u003e\n\u003cli\u003eInstall \u003ca href="https://www.eksworkshop.com/030_eksctl/prerequisites/"\u003eeksctl tools\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eInstall \u003ca href="https://www.eksworkshop.com/beginner/060_helm/helm_intro/install/"\u003eHelm\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eLaunch an \u003ca href="https://www.eksworkshop.com/030_eksctl/launcheks/"\u003eEKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eTest \u003ca href="https://www.eksworkshop.com/030_eksctl/test/"\u003eEKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e(Optional) \u003ca href="https://www.eksworkshop.com/030_eksctl/console/#:~:text=The%20EKS%20console%20allows%20you,granted%20permission%20within%20the%20cluster."\u003eGrant console access to EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="install-ack-service-controller-for-rds"\u003eInstall ACK service controller for RDS\u003c/h2\u003e\n\u003cp\u003eTo manage an Aurora Serverless v2 cluster from Kubernetes / Amazon EKS, you will need to install the ACK for RDS service controller. You can deploy the ACK service controller for Amazon RDS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/rds-chart"\u003erds-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eDefine environment variables\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eSERVICE=rds\nRELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nACK_SYSTEM_NAMESPACE=ack-system\nAWS_REGION=\u0026lt;ADD-REGION-HERE\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | \\\n helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now use the Helm chart to deploy the ACK service controller for Amazon RDS to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the RDS API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the RDS API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n \u0026quot;${ACK_SYSTEM_NAMESPACE}\u0026quot; \u0026quot;oci://public.ecr.aws/aws-controllers-k8s/${SERVICE}-chart\u0026quot; --version=\u0026quot;${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=\u0026quot;${AWS_REGION}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the RDS API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003erds\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-aurora-serverless-v2-postgresql-database"\u003eCreate an Aurora Serverless v2 PostgreSQL database\u003c/h2\u003e\n\u003cp\u003eTo create an Aurora Serverless v2 database using the PostgreSQL engine, you must\nfirst create a DBSubnetGroup and a SecurityGroup for the VPC:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAPP_NAMESPACE=mydb\nkubectl create ns \u0026quot;${APP_NAMESPACE}\u0026quot;\n\nEKS_VPC_ID=$(aws eks describe-cluster --name \u0026quot;${EKS_CLUSTER_NAME}\u0026quot; --query \u0026quot;cluster.resourcesVpcConfig.vpcId\u0026quot; --output text)\n\nRDS_SUBNET_GROUP_NAME=\u0026quot;my-subnet-group\u0026quot;\nRDS_SUBNET_GROUP_DESCRIPTION=\u0026quot;database subnet group\u0026quot;\nEKS_SUBNET_IDS=$(aws ec2 describe-subnets --filter \u0026quot;Name=vpc-id,Values=${EKS_VPC_ID}\u0026quot; --query \'Subnets[?MapPublicIpOnLaunch==`false`].SubnetId\' --output text)\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; db-subnet-groups.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBSubnetGroup\nmetadata:\n name: ${RDS_SUBNET_GROUP_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n name: ${RDS_SUBNET_GROUP_NAME}\n description: ${RDS_SUBNET_GROUP_DESCRIPTION}\n subnetIDs:\n$(printf \u0026quot; - %s\\n\u0026quot; ${EKS_SUBNET_IDS})\n tags: []\nEOF\n\nkubectl apply -f db-subnet-groups.yaml\n\nRDS_SECURITY_GROUP_NAME=\u0026quot;ack-security-group\u0026quot;\nRDS_SECURITY_GROUP_DESCRIPTION=\u0026quot;ACK security group\u0026quot;\n\nEKS_CIDR_RANGE=$(aws ec2 describe-vpcs \\\n --vpc-ids \u0026quot;${EKS_VPC_ID}\u0026quot; \\\n --query \u0026quot;Vpcs[].CidrBlock\u0026quot; \\\n --output text\n)\n\nRDS_SECURITY_GROUP_ID=$(aws ec2 create-security-group \\\n --group-name \u0026quot;${RDS_SECURITY_GROUP_NAME}\u0026quot; \\\n --description \u0026quot;${RDS_SECURITY_GROUP_DESCRIPTION}\u0026quot; \\\n --vpc-id \u0026quot;${EKS_VPC_ID}\u0026quot; \\\n --output text\n)\naws ec2 authorize-security-group-ingress \\\n --group-id \u0026quot;${RDS_SECURITY_GROUP_ID}\u0026quot; \\\n --protocol tcp \\\n --port 5432 \\\n --cidr \u0026quot;${EKS_CIDR_RANGE}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSet up a master password using a Kubernetes Secret. Set \u003ccode\u003eRDS_DB_USERNAME\u003c/code\u003e and \u003ccode\u003eRDS_DB_PASSWORD\u003c/code\u003e to your preferred values for your RDS credentials:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e\nRDS_DB_USERNAME=\u0026quot;adminer\u0026quot;\nRDS_DB_PASSWORD=\u0026quot;password\u0026quot;\n\nkubectl create secret generic -n \u0026quot;${APP_NAMESPACE}\u0026quot; ack-creds \\\n --from-literal=username=\u0026quot;${RDS_DB_USERNAME}\u0026quot; \\\n --from-literal=password=\u0026quot;${RDS_DB_PASSWORD}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now create an Aurora Serverless v2 cluster for both the PostgreSQL and\nMySQL database engines. The example below uses the PostgreSQL engine. For example, to use\nMySQL, set \u003ccode\u003eENGINE_TYPE\u003c/code\u003e to \u003ccode\u003eaurora-mysql\u003c/code\u003e and \u003ccode\u003eENGINE_VERSION\u003c/code\u003e to \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.versions"\u003eminimum supported version\u003c/a\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AURORA_DB_CLUSTER_NAME=\u0026quot;ack-db\u0026quot;\nexport AURORA_DB_INSTANCE_NAME=\u0026quot;ack-db-instance01\u0026quot;\nexport AURORA_DB_INSTANCE_CLASS=\u0026quot;db.serverless\u0026quot;\nexport MAX_ACU=64\nexport MIN_ACU=4\n\nexport ENGINE_TYPE=aurora-postgresql\nexport ENGINE_VERSION=13\n\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; asv2-db-cluster.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBCluster\nmetadata:\n name: ${AURORA_DB_CLUSTER_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n backupRetentionPeriod: 7\n serverlessV2ScalingConfiguration:\n maxCapacity: ${MAX_ACU}\n minCapacity: ${MIN_ACU}\n dbClusterIdentifier: ${AURORA_DB_CLUSTER_NAME}\n dbSubnetGroupName: ${RDS_SUBNET_GROUP_NAME}\n engine: ${ENGINE_TYPE}\n engineVersion: \u0026quot;${ENGINE_VERSION}\u0026quot;\n masterUsername: adminer\n masterUserPassword:\n namespace: ${APP_NAMESPACE}\n name: ack-creds\n key: password\n vpcSecurityGroupIDs:\n - ${RDS_SECURITY_GROUP_ID}\nEOF\n\nkubectl apply -f asv2-db-cluster.yaml\n\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; asv2-db-instance.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n dbInstanceClass: ${AURORA_DB_INSTANCE_CLASS}\n dbInstanceIdentifier: ${AURORA_DB_INSTANCE_NAME}\n dbClusterIdentifier: ${AURORA_DB_CLUSTER_NAME}\n dbSubnetGroupName: ${RDS_SUBNET_GROUP_NAME}\n engine: ${ENGINE_TYPE}\n engineVersion: \u0026quot;${ENGINE_VERSION}\u0026quot;\n publiclyAccessible: false\nEOF\n\nkubectl apply -f asv2-db-instance.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Required \u003ccode\u003eserverlessV2ScalingConfiguration\u003c/code\u003e attributes\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n In the \u003ccode\u003eDBCluster\u003c/code\u003e custom resource, you \u003cstrong\u003emust\u003c/strong\u003e set both the \u003ccode\u003eminCapacity\u003c/code\u003e and\n\u003ccode\u003emaxCapacity\u003c/code\u003e attributes in the \u003ccode\u003eserverlessV2ScalingConfiguration\u003c/code\u003e section,\notherwise the database cluster will not be created.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eTo see your newly created Aurora Serverless v2 cluster, you can run the\nfollowing command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe -n \u0026quot;${APP_NAMESPACE}\u0026quot; \u0026quot;dbclusters/${AURORA_DB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="connect-to-database-instances"\u003eConnect to Database Instances\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eDBInstance\u003c/code\u003e status contains the information for connecting to a RDS database instance. The host information can be found in \u003ccode\u003estatus.endpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.endpoint.port\u003c/code\u003e. The master user name can be found in \u003ccode\u003espec.masterUsername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe database password is in the Secret that is referenced in the \u003ccode\u003eDBInstance\u003c/code\u003e spec (\u003ccode\u003espec.masterPassword.name\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. For example, to get the connection information from either RDS database instance created the above example, you can use the following example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAURORA_INSTANCE_CONN_CM=\u0026quot;asv2-db-instance-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; asv2-db-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${AURORA_INSTANCE_CONN_CM}\n namespace: ${APP_NAMESPACE}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-host\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.address\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-port\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.port\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-user\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.spec.masterUsername\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\nEOF\n\nkubectl apply -f asv2-db-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can inject these values into a container either as environmental variables or files. For example, here is a snippet of a Pod definition that will add the RDS instance connection info into the Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-pods.yaml\napiVersion: v1\nkind: Pod\nmetadata:\n name: app\n namespace: ${APP_NAMESPACE}\nspec:\n containers:\n - image: busybox\n name: myapp\n command:\n - sleep\n - \u0026quot;3600\u0026quot;\n imagePullPolicy: IfNotPresent\n env:\n - name: PGHOST\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-host\u0026quot;\n - name: PGPORT\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-port\u0026quot;\n - name: PGUSER\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-user\u0026quot;\n - name: PGPASSWORD\n valueFrom:\n secretKeyRef:\n name: \u0026quot;ack-creds\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-pods.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="cleanup"\u003eCleanup\u003c/h2\u003e\n\u003cp\u003eYou can delete your Aurora Serverless v2 cluster using the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f asv2-db-instance.yaml\nkubectl delete -f asv2-db-cluster.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the RDS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:24,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/eventbridge-example/",title:"Manage EventBridge event buses and rules with the ACK EventBridge Controller",description:"Send filtered events on a custom bus to SQS.",content:'\u003cp\u003eEventBridge is a serverless service that uses events to connect application components together, making it easier for\nyou to build scalable event-driven applications. Use it to route events from sources such as home-grown applications,\nAWS services, and third-party software to consumer applications across your organization. EventBridge provides a simple\nand consistent way to ingest, filter, transform, and deliver events so you can build new applications quickly.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage a custom EventBridge \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html"\u003eevent\nbus\u003c/a\u003e and\n\u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rules.html"\u003erule\u003c/a\u003e to filter and forward messages to an SQS\n\u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html"\u003etarget\u003c/a\u003e from an Amazon Elastic Kubernetes\n(EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to manages queues and send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://stedolan.github.io/jq/download/"\u003ejq\u003c/a\u003e to parse AWS CLI JSON output\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-eventbridge"\u003eInstall the ACK service controller for EventBridge\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon EventBridge using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/eventbridge-chart"\u003eeventbridge-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/eventbridge-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the EventBridge API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003eeventbridge\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-eventbridge-custom-event-bus-and-rule-with-an-sqs-target"\u003eCreate an EventBridge Custom Event Bus and Rule with an SQS Target\u003c/h2\u003e\n\u003ch3 id="create-the-target-sqs-queue"\u003eCreate the target SQS queue\u003c/h3\u003e\n\u003cp\u003eTo keep the scope of this tutorial simple, the SQS queue and IAM permissions will be created with the AWS CLI.\nAlternatively, the \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-sqs"\u003eACK SQS\nController\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-iam"\u003eACK IAM\nController\u003c/a\u003e can be used to manage\nthese resources with Kubernetes.\u003c/p\u003e\n\u003cp\u003eExecute the following command to define the environment variables used throughout the example.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport EVENTBRIDGE_NAMESPACE=eventbridge-example\nexport EVENTBUS_NAME=custom-eventbus-ack\nexport RULE_NAME=custom-eventbus-ack-sqs-rule\nexport TARGET_QUEUE=custom-eventbus-ack-rule-sqs-target\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate the target queue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; target-queue.json\n{\n \u0026quot;QueueName\u0026quot;: \u0026quot;${TARGET_QUEUE}\u0026quot;,\n \u0026quot;Attributes\u0026quot;: {\n \u0026quot;Policy\u0026quot;: \u0026quot;{\\\u0026quot;Statement\\\u0026quot;:[{\\\u0026quot;Sid\\\u0026quot;:\\\u0026quot;EventBridgeToSqs\\\u0026quot;,\\\u0026quot;Effect\\\u0026quot;:\\\u0026quot;Allow\\\u0026quot;,\\\u0026quot;Principal\\\u0026quot;:{\\\u0026quot;Service\\\u0026quot;:\\\u0026quot;events.amazonaws.com\\\u0026quot;},\\\u0026quot;Action\\\u0026quot;:[\\\u0026quot;sqs:SendMessage\\\u0026quot;],\\\u0026quot;Resource\\\u0026quot;:\\\u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${TARGET_QUEUE}\\\u0026quot;,\\\u0026quot;Condition\\\u0026quot;:{\\\u0026quot;ArnEquals\\\u0026quot;:{\\\u0026quot;aws:SourceArn\\\u0026quot;:\\\u0026quot;arn:aws:events:${AWS_REGION}:${AWS_ACCOUNT_ID}:rule/${EVENTBUS_NAME}/${RULE_NAME}\\\u0026quot;}}}]}\u0026quot;\n }\n}\nEOF\n\naws sqs create-queue --cli-input-json file://target-queue.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/custom-eventbus-ack-rule-sqs-target\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-custom-event-bus"\u003eCreate a Custom Event Bus\u003c/h3\u003e\n\u003cp\u003eExecute the following command to create the example namespace and a custom event bus.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create ns ${EVENTBRIDGE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; bus.yaml\napiVersion: eventbridge.services.k8s.aws/v1alpha1\nkind: EventBus\nmetadata:\n name: ${EVENTBUS_NAME}\nspec:\n name: ${EVENTBUS_NAME}\nEOF\n\nkubectl -n ${EVENTBRIDGE_NAMESPACE} create -f bus.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003enamespace/eventbridge-example created\neventbus.eventbridge.services.k8s.aws/custom-eventbus-ack created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the event bus resource is synchronized.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} get eventbus ${EVENTBUS_NAME}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SYNCED AGE\ncustom-eventbus-ack True 64s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-rule-with-an-sqs-target"\u003eCreate a Rule with an SQS Target\u003c/h3\u003e\n\u003cp\u003eExecute the following command to retrieve the ARN for the SQS target created above needed for the Kubernetes manifest.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport TARGET_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eExecute the following command to create a Kubernetes manifest for a rule, forwarding events matching the specified rule\nfilter criteria to the target queue. The EventBridge filter pattern will match any event received on the custom event\nbus with a \u003ccode\u003edetail-type\u003c/code\u003e of \u003ccode\u003eevent.from.ack.v0\u003c/code\u003e. Alternatively, the filter pattern can be omitted to forward all events\nfrom the custom event bus.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rule.yaml\napiVersion: eventbridge.services.k8s.aws/v1alpha1\nkind: Rule\nmetadata:\n name: $RULE_NAME\nspec:\n name: $RULE_NAME\n description: \u0026quot;ACK EventBridge Filter Rule to SQS using event bus reference\u0026quot;\n eventBusRef:\n from:\n name: $EVENTBUS_NAME\n eventPattern: |\n {\n \u0026quot;detail-type\u0026quot;:[\u0026quot;event.from.ack.v0\u0026quot;]\n }\n targets:\n - arn: $TARGET_QUEUE_ARN\n id: sqs-rule-target\n retryPolicy:\n maximumRetryAttempts: 0 # no retries\nEOF\n\nkubectl -n ${EVENTBRIDGE_NAMESPACE} create -f rule.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003erule.eventbridge.services.k8s.aws/custom-eventbus-ack-sqs-rule created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the rule resource is synchronized.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} get rule ${RULE_NAME}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SYNCED AGE\ncustom-eventbus-ack-sqs-rule True 18s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="verify-the-event-filtering-and-forwarding-is-working"\u003eVerify the event filtering and forwarding is working\u003c/h3\u003e\n\u003cp\u003eExecute the following command to send an event to the custom bus matching the rule filter pattern.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; event.json\n[\n {\n \u0026quot;Source\u0026quot;: \u0026quot;my.aws.events.cli\u0026quot;,\n \u0026quot;DetailType\u0026quot;: \u0026quot;event.from.ack.v0\u0026quot;,\n \u0026quot;Detail\u0026quot;: \u0026quot;{\\\u0026quot;hello-world\\\u0026quot;:\\\u0026quot;from ACK for EventBridge\\\u0026quot;}\u0026quot;,\n \u0026quot;EventBusName\u0026quot;: \u0026quot;${EVENTBUS_NAME}\u0026quot;\n }\n]\nEOF\n\naws events put-events --entries file://event.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;FailedEntryCount\u0026quot;: 0,\n \u0026quot;Entries\u0026quot;: [\n {\n \u0026quot;EventId\u0026quot;: \u0026quot;ccd21ee8-339d-cabe-520d-b847c98ba2cb\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was received by the SQS queue with\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026quot;MessageId\u0026quot;: \u0026quot;80cef2f3-ff25-4441-9217-665bb0217ec5\u0026quot;,\n \u0026lt;snip\u0026gt;\n \u0026quot;Body\u0026quot;: \u0026quot;{\\\u0026quot;version\\\u0026quot;:\\\u0026quot;0\\\u0026quot;,\\\u0026quot;id\\\u0026quot;:\\\u0026quot;def3d99b-806b-5d92-d036-9e0884bdc387\\\u0026quot;,\\\u0026quot;detail-type\\\u0026quot;:\\\u0026quot;event.from.ack.v0\\\u0026quot;,\\\u0026quot;source\\\u0026quot;:\\\u0026quot;my.aws.events.cli\\\u0026quot;,\\\u0026quot;account\\\u0026quot;:\\\u0026quot;1234567890\\\u0026quot;,\\\u0026quot;time\\\u0026quot;:\\\u0026quot;2023-03-22T11:22:34Z\\\u0026quot;,\\\u0026quot;region\\\u0026quot;:\\\u0026quot;us-east-1\\\u0026quot;,\\\u0026quot;resources\\\u0026quot;:[],\\\u0026quot;detail\\\u0026quot;:{\\\u0026quot;hello-world\\\u0026quot;:\\\u0026quot;from ACK for EventBridge\\\u0026quot;}}\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon EventBridge is based on the \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html"\u003eAmazon EventBridge\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eEventBridge\u003c/em\u003e to find all the\nsupported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} delete -f rule.yaml\nkubectl -n ${EVENTBRIDGE_NAMESPACE} delete -f bus.yaml\nkubectl delete ns ${EVENTBRIDGE_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003erule.eventbridge.services.k8s.aws \u0026quot;custom-eventbus-ack-sqs-rule\u0026quot; deleted\neventbus.eventbridge.services.k8s.aws \u0026quot;custom-eventbus-ack\u0026quot; deleted\nnamespace \u0026quot;eventbridge-example\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRemove the manually created SQS resource.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eTo remove the EventBridge ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:25,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/pipes-example/",title:"Manage EventBridge Pipes with the ACK Pipes Controller",description:"Forward messages between two SQS queues with a pipe.",content:'\u003cp\u003eAmazon EventBridge Pipes connects sources to targets. It reduces the need for specialized knowledge and integration code\nwhen developing event driven architectures, fostering consistency across your company’s applications. To set up a pipe,\nyou choose the source, add optional filtering, define optional enrichment, and choose the target for the event data.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage an \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"\u003eEventBridge\nPipe\u003c/a\u003e to forward messages between two SQS queues\nfrom an Amazon Elastic Kubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to manages queues and send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://stedolan.github.io/jq/download/"\u003ejq\u003c/a\u003e to parse AWS CLI JSON output\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-pipes"\u003eInstall the ACK service controller for Pipes\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon Pipes using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/pipes-chart"\u003epipes-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/pipes-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/pipes-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the Pipes API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003epipes\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-eventbridge-pipe"\u003eCreate an EventBridge Pipe\u003c/h2\u003e\n\u003ch3 id="create-the-source-and-target-sqs-queues"\u003eCreate the source and target SQS queues\u003c/h3\u003e\n\u003cp\u003eTo keep the scope of this tutorial simple, the SQS queues and IAM permissions will be created with the AWS CLI.\nAlternatively, the \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-sqs"\u003eACK SQS\nController\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-iam"\u003eACK IAM\nController\u003c/a\u003e can be used to manage\nthese resources with Kubernetes.\u003c/p\u003e\n\u003cp\u003eExecute the following command to define the environment variables used throughout the example.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport PIPE_NAME=pipes-sqs-to-sqs\nexport PIPE_NAMESPACE=pipes-example\nexport SOURCE_QUEUE=pipes-sqs-source\nexport TARGET_QUEUE=pipes-sqs-target\nexport PIPE_ROLE=pipes-sqs-to-sqs-role\nexport PIPE_POLICY=pipes-sqs-to-sqs-policy\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate the source and target queues.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs create-queue --queue-name ${SOURCE_QUEUE}\naws sqs create-queue --queue-name ${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/pipes-sqs-source\u0026quot;\n}\n{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/pipes-sqs-target\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-the-pipes-iam-role"\u003eCreate the Pipes IAM Role\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role for the pipe to consume messages from the source queue and send messages to the target queue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; trust.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;pipes.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;aws:SourceAccount\u0026quot;: \u0026quot;${AWS_ACCOUNT_ID}\u0026quot;\n }\n }\n }\n ]\n}\nEOF\n\naws iam create-role --role-name ${PIPE_ROLE} --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Role\u0026quot;: {\n \u0026quot;Path\u0026quot;: \u0026quot;/\u0026quot;,\n \u0026quot;RoleName\u0026quot;: \u0026quot;pipes-sqs-to-sqs-role\u0026quot;,\n \u0026quot;RoleId\u0026quot;: \u0026quot;ABCDU3F4JDBEUCMGT3XBH\u0026quot;,\n \u0026quot;Arn\u0026quot;: \u0026quot;arn:aws:iam::1234567890:role/pipes-sqs-to-sqs-role\u0026quot;,\n \u0026quot;CreateDate\u0026quot;: \u0026quot;2023-03-21T13:11:59+00:00\u0026quot;,\n \u0026quot;AssumeRolePolicyDocument\u0026quot;: {\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;pipes.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;aws:SourceAccount\u0026quot;: \u0026quot;1234567890\u0026quot;\n }\n }\n }\n ]\n }\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach a policy to the role to give the pipe permissions to read and send messages.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; policy.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sqs:ReceiveMessage\u0026quot;,\n \u0026quot;sqs:DeleteMessage\u0026quot;,\n \u0026quot;sqs:GetQueueAttributes\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${SOURCE_QUEUE}\u0026quot;\n ]\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sqs:SendMessage\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${TARGET_QUEUE}\u0026quot;\n ]\n }\n ]\n}\nEOF\n\naws iam put-role-policy --role-name ${PIPE_ROLE} --policy-name ${PIPE_POLICY} --policy-document file://policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003ch3 id="create-the-pipe"\u003eCreate the Pipe\u003c/h3\u003e\n\u003cp\u003eExecute the following command to retrieve the ARNs for the resources created above needed for the Kubernetes manifest.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SOURCE_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\nexport TARGET_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\nexport PIPE_ROLE_ARN=$(aws --output json iam get-role --role-name ${PIPE_ROLE} | jq -r \'.Role.Arn\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eExecute the following command to create a Kubernetes manifest for a pipe consuming messages from the source queue and\nsending messages matching the filter criteria to the target queue using the above created IAM role.\u003c/p\u003e\n\u003cp\u003eThe EventBridge filter pattern will match any SQS message from the source queue with a JSON-stringified body\n\u003ccode\u003e{\\\u0026quot;from\\\u0026quot;:\\\u0026quot;kubernetes\\\u0026quot;}\u003c/code\u003e. Alternatively, the filter pattern can be omitted to forward all messages from the source\nqueue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create ns ${PIPE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; pipe-sqs-to-sqs.yaml\napiVersion: pipes.services.k8s.aws/v1alpha1\nkind: Pipe\nmetadata:\n name: $PIPE_NAME\nspec:\n name: $PIPE_NAME\n source: $SOURCE_QUEUE_ARN\n description: \u0026quot;SQS to SQS Pipe with filtering\u0026quot;\n sourceParameters:\n filterCriteria:\n filters:\n - pattern: \u0026quot;{\\\u0026quot;body\\\u0026quot;:{\\\u0026quot;from\\\u0026quot;:[\\\u0026quot;kubernetes\\\u0026quot;]}}\u0026quot;\n sqsQueueParameters:\n batchSize: 1\n maximumBatchingWindowInSeconds: 1\n target: $TARGET_QUEUE_ARN\n roleARN: $PIPE_ROLE_ARN\nEOF\n\nkubectl -n ${PIPE_NAMESPACE} create -f pipe-sqs-to-sqs.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003enamespace/pipes-example created\npipe.pipes.services.k8s.aws/pipes-sqs-to-sqs created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="describe-pipe-custom-resource"\u003eDescribe Pipe Custom Resource\u003c/h3\u003e\n\u003cp\u003eView the Pipe custom resource to verify it is in a \u003ccode\u003eRUNNING\u003c/code\u003e state.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n $PIPE_NAMESPACE get pipe $PIPE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME STATE SYNCED AGE\npipes-sqs-to-sqs RUNNING True 3m10s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="verify-the-pipe-filtering-and-forwarding-is-working"\u003eVerify the Pipe filtering and forwarding is working\u003c/h3\u003e\n\u003cp\u003eExecute the following command to send a message to the source queue with a body matching the pipe filter pattern.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs send-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE} --message-body \u0026quot;{\\\u0026quot;from\\\u0026quot;:\\\u0026quot;kubernetes\\\u0026quot;}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;MD5OfMessageBody\u0026quot;: \u0026quot;fde2da607356f1974691e48fa6a87157\u0026quot;,\n \u0026quot;MessageId\u0026quot;: \u0026quot;f4157187-0308-420c-b69b-aa439e6be7e3\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was consumed by the pipe, the filter pattern matched and the message was received by the target queue\nwith\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Receive Delays\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It might take some time for the Pipe to consume the message from the source and deliver it to the target queue.\nIf the above command does not return a message, rerun the command a couple of times with some delay in between the requests.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026lt;snip\u0026gt;\n \u0026quot;MD5OfBody\u0026quot;: \u0026quot;d5255184c571cca2c78e76d6eea1745d\u0026quot;,\n \u0026quot;Body\u0026quot;: \u0026quot;{\\\u0026quot;messageId\\\u0026quot;:\\\u0026quot;f4157187-0308-420c-b69b-aa439e6be7e3\\\u0026quot;,\n \u0026lt;snip\u0026gt;\n \\\u0026quot;body\\\u0026quot;:\\\u0026quot;{\\\\\\\u0026quot;from\\\\\\\u0026quot;:\\\\\\\u0026quot;kubernetes\\\\\\\u0026quot;}\\\u0026quot;,\\\u0026quot;attributes\\\u0026quot;:{\\\u0026quot;ApproximateReceiveCount\\\u0026quot;:\\\u0026quot;1\\\u0026quot;,\n \u0026lt;snip\u0026gt;\n \\\u0026quot;eventSourceARN\\\u0026quot;:\\\u0026quot;arn:aws:sqs:us-east-1:1234567890:pipes-sqs-source\\\u0026quot;,\\\u0026quot;awsRegion\\\u0026quot;:\\\u0026quot;us-east-1\\\u0026quot;}\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon EventBridge Pipes is based on the \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/Welcome.html"\u003eAmazon EventBridge Pipes\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003ePipes\u003c/em\u003e to find all the\nsupported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the Pipes resources created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${PIPE_NAMESPACE} delete -f pipe-sqs-to-sqs.yaml\nkubectl delete ns ${PIPE_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003epipe.pipes.services.k8s.aws \u0026quot;pipes-sqs-to-sqs\u0026quot; deleted\nnamespace \u0026quot;pipes-example\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Deleting Delays\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It might take some time for the Pipe to be deleted as the operation is performed asynchronously in the API.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eRemove the manually created SQS resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE}\naws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eRemove the manually created IAM resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam delete-role-policy --role-name ${PIPE_ROLE} --policy-name ${PIPE_POLICY}\naws iam delete-role --role-name ${PIPE_ROLE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eTo remove the Pipes ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:26,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/sqs-example/",title:"Manage SQS queues with the ACK SQS Controller",description:"Create an SQS queue from an Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eAmazon Simple Queue Service (SQS) is a fully managed message queuing service for microservices, distributed systems, and\nserverless applications. SQS lets you send, store, and receive messages between software components\nwithout losing messages or requiring other services to be available.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage \u003ca href="https://aws.amazon.com/sqs"\u003eSQS\u003c/a\u003e queues from an Amazon Elastic\nKubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-sqs"\u003eInstall the ACK service controller for SQS\u003c/h3\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003e\u003cem\u003eNOTE:\u003c/em\u003e\u003c/strong\u003e This guide assumes you\u0026rsquo;re using \u003ccode\u003eus-east-1\u003c/code\u003e as the region where the ACK controller will be deployed, as well as the Amazon SQS resource. If you want to create the object in another resource, simply change the region name to your region of choice.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon SQS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/sqs-chart"\u003esqs-chart Helm chart\u003c/a\u003e. If you\u0026rsquo;re looking to deploy resources to multiple regions, please refer to the \u003ca href="%5Burl%5D(https://aws-controllers-k8s.github.io/community/docs/user-docs/multi-region-resource-management/)"\u003eManage Resources In Multiple Regions\u003c/a\u003e documentation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eCONTROLLER_REGION=us-east-1\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/sqs-chart --version=1.0.4 --generate-name --set=aws.region=$CONTROLLER_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/sqs-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the SQS API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003esqs\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-sqs-queue"\u003eCreate an SQS Queue\u003c/h2\u003e\n\u003cp\u003eExecute the following command to create a manifest for a basic SQS queue, with an inline policy with \u003ccode\u003eSendMessage\u003c/code\u003e\npermissions for the account owner, and submit this manifest to EKS cluster using kubectl.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eQUEUE_NAMESPACE=sqs-example\nQUEUE_NAME=basic-sqs\n\nkubectl create ns ${QUEUE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; basic-sqs-queue.yaml\napiVersion: sqs.services.k8s.aws/v1alpha1\nkind: Queue\nmetadata:\n name: ${QUEUE_NAME}\n annotations:\n services.k8s.aws/region: ${AWS_REGION}\nspec:\n queueName: ${QUEUE_NAME}\n policy: |\n {\n \u0026quot;Statement\u0026quot;: [{\n \u0026quot;Sid\u0026quot;: \u0026quot;__owner_statement\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;AWS\u0026quot;: \u0026quot;${AWS_ACCOUNT_ID}\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sqs:SendMessage\u0026quot;,\n \u0026quot;Resource\u0026quot;: \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${QUEUE_NAME}\u0026quot;\n }]\n }\nEOF\n\nkubectl -n ${QUEUE_NAMESPACE} create -f basic-sqs-queue.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003enamespace/sqs-example created\nqueue.sqs.services.k8s.aws/basic-sqs created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="describe-sqs-custom-resource"\u003eDescribe SQS Custom Resource\u003c/h2\u003e\n\u003cp\u003eView the SQS custom resource to retrieve the \u003ccode\u003eQueue URL\u003c/code\u003e in the \u003ccode\u003eStatus\u003c/code\u003e field\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n $QUEUE_NAMESPACE describe queue $QUEUE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: basic-sqs\nNamespace: sqs-example\n\u0026lt;snip\u0026gt;\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:sqs:us-east-1:1234567890:basic-sqs\n Owner Account ID: 1234567890\n Region: us-east-1\n Conditions:\n Last Transition Time: 2023-02-22T13:31:43Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Queue URL: https://sqs.us-east-1.amazonaws.com/1234567890/basic-sqs\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCopy and set the Queue URL as an environment variable\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eQUEUE_URL=$(kubectl -n $QUEUE_NAMESPACE get queues/basic-sqs -o jsonpath=\'{.status.queueURL}\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="send-a-message"\u003eSend a Message\u003c/h2\u003e\n\u003cp\u003eExecute the following command to send a message to the queue\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs send-message --queue-url ${QUEUE_URL} --message-body \u0026quot;hello from ACK\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\n \u0026quot;MD5OfMessageBody\u0026quot;: \u0026quot;51e9ec3a483ba8b3159bc5fddcbbf36a\u0026quot;,\n \u0026quot;MessageId\u0026quot;: \u0026quot;281d7695-b066-4a50-853e-1b7c6c65f4a9\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was received with\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url ${QUEUE_URL}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026quot;MessageId\u0026quot;: \u0026quot;281d7695-b066-4a50-853e-1b7c6c65f4a9\u0026quot;,\n \u0026quot;ReceiptHandle\u0026quot;: \u0026quot;ABCDeFZQxPfbAI201bRkdHZvRWeJUVSFfm2eL/T91L23ltB9nmf0dcx3ALQHz2WsXZhAbThZR+Ns5rX42+OjySNG6pi9Iu/SRZCVuuMzSBXeTrnLo8JjK3h9KE3uUkWirINgXd4fgVR2/C7feI3lCUhMOVhhYhec8ej5EDorL85Ay1IwZ43WYUQ1bIschP6xDvfzHk6vCi3kCXz6ZvPsNH3kTxp1gEvpQsaL/cq+aIZt/d1VVFsHtExbEk32iK1bo39tyA1A3Q7pT2WMowYh6MrfYdHoBw7PxJueGgx9MIQhQge2E+g6rKzGpFN9oPzPx59gu8n8n7Or6oncNM57pESD2LdzWTYjmS5H+Aw74qJ/gAMBIDNVuFt4Wl/5BvJHUTpOSAdi+Jekdbm3+AegzX8qyA==\u0026quot;,\n \u0026quot;MD5OfBody\u0026quot;: \u0026quot;51e9ec3a483ba8b3159bc5fddcbbf36a\u0026quot;,\n \u0026quot;Body\u0026quot;: \u0026quot;hello from ACK\u0026quot;\n }\n ]\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon SQS is based on the \u003ca href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html"\u003eAmazon SQS\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eSQS\u003c/em\u003e to find all the supported\nKubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${QUEUE_NAMESPACE} delete -f basic-sqs-queue.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003equeue.sqs.services.k8s.aws \u0026quot;basic-sqs\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SQS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:27,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/lambda-oci-example/",title:"Create a Lambda OCI Function with the ACK Lambda Controller",description:"Create a Lambda Function with an OCI Image Using the ACK Lambda Controller deployed on Amazon Elastic Kubernetes Service (EKS).",content:'\u003cp\u003eThe ACK service controller for Amazon Lambda lets you manage Lambda functions directly from Kubernetes.\nThis guide shows you how to create a Lambda function with OCI image using a single Kubernetes resource manifest.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Registry (Amazon ECR) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster and Amazon ECR repository, see\n\u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e and \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/get-set-up-for-amazon-ecr.html"\u003eAmazon ECR Setup\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eHave access to Amazon ECR\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/engine/install/"\u003eDocker\u003c/a\u003e - A tool to build, share, and run containers.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-lambda"\u003eInstall the ACK service controller for Lambda\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-west-2 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon Lambda using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/lambda-chart"\u003elambda-chart Helm chart\u003c/a\u003e. This example creates resources in the \u003ccode\u003eus-west-2\u003c/code\u003e region, but you can use any other region supported in AWS.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eSERVICE=lambda\nRELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/lambda-chart \u0026quot;--version=${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=us-west-2\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to invoke the Lambda API. For full details, please review the AWS Controllers for Kubernetes documentation\nfor \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the\nvalue of \u003ccode\u003elambda\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-lambda-function-handler"\u003eCreate Lambda function handler\u003c/h2\u003e\n\u003cp\u003eThe Lambda \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html"\u003efunction handler\u003c/a\u003e is the method in your function code that processes events. When your function is invoked, Lambda runs the handler method.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; app.js\nexports.handler = async (event) =\u0026gt; {\n const response = {\n statusCode: 200\n body: JSON.stringify(\'Hello from Lambda!\')\n };\n return response;\n};\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-and-build-a-docker-image"\u003eCreate and Build a Docker Image\u003c/h2\u003e\n\u003cp\u003eCreate a Dockerfile that will be used to build the image for our Lambda function:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; Dockerfile\nFROM public.ecr.aws/lambda/nodejs:14\n\nCOPY app.js package.json ./\n\nRUN npm install\n\nCMD [ \u0026quot;app.handler\u0026quot; ]\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBuild the Docker image in your local environment. You will need to install dependencies using \u003ccode\u003enpm\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003enpm init -y\ndocker build -t hello-world .\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="publish-the-docker-image-to-ecr"\u003ePublish the Docker image to ECR\u003c/h2\u003e\n\u003cp\u003ePublish the Docker image to an ECR repository. It\u0026rsquo;s a requirement for container images to be published to the ECR repository to run Lambda OCI image functions.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport AWS_REGION=us-west-2\n\naws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin ${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com\naws ecr create-repository --repository-name hello-world --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE\ndocker tag \u0026quot;hello-world:latest ${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest\u0026quot;\ndocker push \u0026quot;${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="deploy-the-lambda-oci-function-using-the-ack-lambda-controller"\u003eDeploy the Lambda OCI function using the ACK Lambda controller\u003c/h2\u003e\n\u003cp\u003eThe following example creates a manifest that contains the Lambda OCI function. It then uses \u003ccode\u003ekubectl\u003c/code\u003e to create the resource in Kubernetes:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport IMAGE_URI=\u0026quot;${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest \u0026quot;\nexport FUNCTION_NAME=\u0026quot;lambda-oci-ack\u0026quot;\nexport LAMBDA_ROLE=\u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:role/lambda_basic_execution\u0026quot;\n\nread -r -d \'\' LAMBDA_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: lambda.services.k8s.aws/v1alpha1\nkind: Function\nmetadata:\n name: $FUNCTION_NAME\n annotations:\n services.k8s.aws/region: $AWS_REGION\nspec:\n name: $FUNCTION_NAME\n packageType: Image\n code:\n imageURI: $IMAGE_URI\n role: $LAMBDA_ROLE\n description: function created by ACK lambda-controller e2e tests\nEOF\n\necho \u0026quot;${LAMBDA_MANIFEST}\u0026quot; \u0026gt; function.yaml\n\nkubectl create -f function.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou should get a confirmation that the function was created successfully.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efunction.lambda.services.k8s.aws/lambda-oci-ack created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo get details about the Lambda function, run the following.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe \u0026quot;function/${FUNCTION_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="invoke-the-lambda-oci-function"\u003eInvoke the Lambda OCI Function\u003c/h2\u003e\n\u003cp\u003eAfter you have verified that the Lambda OCI function is deployed correctly, you can invoke the function through the \u003ca href="https://docs.aws.amazon.com/cli/latest/reference/lambda/index.html"\u003eAWS CLI\u003c/a\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws lambda invoke --function-name ${FUNCTION_NAME} --region us-west-2 /dev/stdout | jq\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou will get the output as below:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\u0026quot;statusCode\u0026quot;:200,\u0026quot;body\u0026quot;:\u0026quot;\\\u0026quot;Hello from Lambda!\\\u0026quot;\u0026quot;} \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon Lambda is based on the \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html"\u003eAmazon Lambda API\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eLambda\u003c/em\u003e to find\nall the supported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your Lambda OCI function using the \u003ccode\u003ekubectl delete\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f function.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the Lambda ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:28,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/emr-on-eks-example/",title:"Run Spark jobs using the ACK EMR on EKS controller",description:"ACK service controller for EMR on EKS enables customers to run spark jobs on EKS clusters",content:'\u003cp\u003eUsing ACK service controller for EMR on EKS, customers have the ability to define and run EMR jobs directly from their Kubernetes clusters. EMR on EKS manages the lifecycle of these jobs and it is \u003ca href="https://aws.amazon.com/blogs/big-data/amazon-emr-on-amazon-eks-provides-up-to-61-lower-costs-and-up-to-68-performance-improvement-for-spark-workloads/"\u003e3.5 times faster than open-source Spark\u003c/a\u003e because it uses highly optimized EMR runtime\u003c/p\u003e\n\u003cp\u003eTo get started, you can download the EMR on EKS controller image from \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/emrcontainers-controller"\u003eAmazon ECR\u003c/a\u003e and run Spark jobs in minutes. ACK service controller for EMR on EKS is \u003cstrong\u003egenerally available\u003c/strong\u003e. To learn more about EMR on EKS, visit our \u003ca href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="installation-steps"\u003eInstallation steps\u003c/h2\u003e\n\u003cp\u003eHere are the steps involved for installing EMR on EKS controller.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="#install-eks-cluster"\u003eInstall EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#create-iam-identity-mapping"\u003eCreate IAM Identity mapping\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="2"\u003e\n\u003cli\u003e\u003ca href="#install-emrcontainers-controller-in-your-eks-cluster"\u003eInstall emrcontainers-controller\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#configure-irsa-for-emr-on-eks-controller"\u003eConfigure IRSA for emr on eks controller\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="3"\u003e\n\u003cli\u003e\u003ca href="#create-emr-virtualcluster"\u003eCreate EMR VirtualCluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#create-job-execution-role"\u003eCreate EMR Job Execution Role \u0026amp; configure IRSA\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="4"\u003e\n\u003cli\u003e\u003ca href="#run-a-sample-spark-job"\u003eRun a sample job\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch4 id="prereqs"\u003ePrereqs\u003c/h4\u003e\n\u003cp\u003eInstall these tools before proceeding:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-linux.html"\u003eAWS CLI\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ekubectl\u003c/code\u003e - \u003ca href="https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/"\u003ethe Kubernetes CLI\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eeksctl\u003c/code\u003e - \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003ethe CLI for AWS EKS\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eyq\u003c/code\u003e - \u003ca href="https://github.com/mikefarah/yq"\u003eYAML processor\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ehelm\u003c/code\u003e - \u003ca href="https://helm.sh/docs/intro/install/"\u003ethe package manager for Kubernetes\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eConfigure AWS CLI with sufficient permissions to install EKS cluster. Please see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003edocumentation\u003c/a\u003e for further guidance\u003c/p\u003e\n\u003ch2 id="install-eks-cluster"\u003eInstall EKS cluster\u003c/h2\u003e\n\u003cp\u003eYou can either create an EKS cluster or re-use existing one. Below listed are steps for creating new EKS cluster. Let\u0026rsquo;s export environment variables that are needed for the EMR on EKS cluster setup. Please copy and paste commands into terminal for faster provisioning\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport EKS_CLUSTER_NAME=\u0026quot;ack-emr-eks\u0026quot;\nexport AWS_REGION=\u0026quot;us-west-2\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe\u0026rsquo;ll use eksctl to install EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eeksctl create cluster -f - \u0026lt;\u0026lt; EOF\n---\napiVersion: eksctl.io/v1alpha5\nkind: ClusterConfig\nmetadata:\n name: ${EKS_CLUSTER_NAME}\n region: ${AWS_REGION}\n version: \u0026quot;1.23\u0026quot;\n\nmanagedNodeGroups:\n - instanceType: m5.xlarge\n name: ${EKS_CLUSTER_NAME}-ng\n desiredCapacity: 2\n\niam:\n withOIDC: true\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-iam-identity-mapping"\u003eCreate IAM Identity mapping\u003c/h4\u003e\n\u003cp\u003eWe need to create emr-containers identity in EKS cluster so that EMR service has proper RBAC permissions needed to run and manage Spark jobs\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport EMR_NAMESPACE=emr-ns\necho \u0026quot;creating namespace for $SERVICE\u0026quot;\nkubectl create ns $EMR_NAMESPACE\n\necho \u0026quot;creating iamidentitymapping using eksctl\u0026quot;\neksctl create iamidentitymapping \\\n --cluster $EKS_CLUSTER_NAME \\\n --namespace $EMR_NAMESPACE \\\n --service-name \u0026quot;emr-containers\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e2022-08-26 09:07:42 [ℹ] created \u0026quot;emr-ns:Role.rbac.authorization.k8s.io/emr-containers\u0026quot;\n2022-08-26 09:07:42 [ℹ] created \u0026quot;emr-ns:RoleBinding.rbac.authorization.k8s.io/emr-containers\u0026quot;\n2022-08-26 09:07:42 [ℹ] adding identity \u0026quot;arn:aws:iam::012345678910:role/AWSServiceRoleForAmazonEMRContainers\u0026quot; to auth ConfigMap\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="install-emrcontainers-controller-in-your-eks-cluster"\u003eInstall emrcontainers-controller in your EKS cluster\u003c/h2\u003e\n\u003cp\u003eNow we can go ahead and install EMR on EKS controller. First, let\u0026rsquo;s export environment variables needed for setup\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=emrcontainers\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nexport ACK_SYSTEM_NAMESPACE=ack-system\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe cam use Helm for the installation\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;installing ack-$SERVICE-controller\u0026quot;\naws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller \\\n oci://public.ecr.aws/aws-controllers-k8s/$SERVICE-chart --version=$RELEASE_VERSION --set=aws.region=$AWS_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME: ack-emrcontainers-controller\nLAST DEPLOYED: Fri Aug 26 09:05:08 2022\nNAMESPACE: ack-system\nSTATUS: deployed\nREVISION: 1\nTEST SUITE: None\nNOTES:\nemrcontainers-chart has been installed.\nThis chart deploys \u0026quot;public.ecr.aws/aws-controllers-k8s/emrcontainers-controller:0.0.6\u0026quot;.\n\nCheck its status by running:\n kubectl --namespace ack-system get pods -l \u0026quot;app.kubernetes.io/instance=ack-emrcontainers-controller\u0026quot;\n\nYou are now able to create Amazon EMR on EKS (EMRContainers) resources!\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="configure-irsa-for-emr-on-eks-controller"\u003eConfigure IRSA for emr on eks controller\u003c/h4\u003e\n\u003cp\u003eOnce the controller is deployed, you need to setup IAM permissions for the controller so that it can create and manage resources using EMR, S3 and other API\u0026rsquo;s. We will use \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Account\u003c/a\u003e to secure this IAM role so that only EMR on EKS controller service account can assume the permissions assigned.\u003c/p\u003e\n\u003cp\u003ePlease follow \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003ehow to configure IAM permissions\u003c/a\u003e for IRSA setup. Make sure to change the value for \u003cstrong\u003e\u003ccode\u003eSERVICE\u003c/code\u003e\u003c/strong\u003e to \u003cstrong\u003e\u003ccode\u003eemrcontainers\u003c/code\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003cp\u003eAfter completing all the steps, please validate annotation for service account before proceeding.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e# validate annotation\nkubectl get pods -n $ACK_SYSTEM_NAMESPACE\nCONTROLLER_POD_NAME=$(kubectl get pods -n $ACK_SYSTEM_NAMESPACE --selector=app.kubernetes.io/name=emrcontainers-chart -o jsonpath=\'{.items..metadata.name}\')\nkubectl describe pod -n $ACK_SYSTEM_NAMESPACE $CONTROLLER_POD_NAME | grep \u0026quot;^\\s*AWS_\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eAWS_REGION: us-west-2\nAWS_ENDPOINT_URL: \nAWS_ROLE_ARN: arn:aws:iam::012345678910:role/ack-emrcontainers-controller\nAWS_WEB_IDENTITY_TOKEN_FILE: /var/run/secrets/eks.amazonaws.com/serviceaccount/token (http://eks.amazonaws.com/serviceaccount/token)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-emr-virtualcluster"\u003eCreate EMR VirtualCluster\u003c/h2\u003e\n\u003cp\u003eWe can now create EMR Virtual Cluster. An EMR Virtual Cluster is mapped to a Kubernetes namespace. EMR uses virtual clusters to run jobs and host endpoints.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt; EOF \u0026gt; virtualcluster.yaml\n---\napiVersion: emrcontainers.services.k8s.aws/v1alpha1\nkind: VirtualCluster\nmetadata:\n name: my-ack-vc\nspec:\n name: my-ack-vc\n containerProvider:\n id: $EKS_CLUSTER_NAME\n type_: EKS\n info:\n eksInfo:\n namespace: emr-ns\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s create a virtualcluster\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eenvsubst \u0026lt; virtualcluster.yaml | kubectl apply -f -\nkubectl describe virtualclusters\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eName: my-ack-vc\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: emrcontainers.services.k8s.aws/v1alpha1\nKind: VirtualCluster\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:emr-containers:us-west-2:012345678910:/virtualclusters/dxnqujbxexzri28ph1wspbxo0\n Owner Account ID: 012345678910\n Region: us-west-2\n Conditions:\n Last Transition Time: 2022-08-26T17:21:26Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Id: dxnqujbxexzri28ph1wspbxo0\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-job-execution-role"\u003eCreate Job Execution Role\u003c/h4\u003e\n\u003cp\u003eIn order to run sample spark job, we need to create EMR Job Execution Role. This Role will have IAM permissions such as S3, CloudWatch Logs for running your job. We will use IRSA to secure this job role\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eACK_JOB_EXECUTION_ROLE=\u0026quot;ack-${SERVICE}-jobexecution-role\u0026quot;\nACK_JOB_EXECUTION_IAM_ROLE_DESCRIPTION=\u0026quot;IRSA role for ACK ${SERVICE} Job Execution\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; job_trust.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Sid\u0026quot;: \u0026quot;\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;ec2.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;\n }\n ]\n}\nEOF\naws iam create-role --role-name \u0026quot;${ACK_JOB_EXECUTION_ROLE}\u0026quot; \\\n --assume-role-policy-document file://job_trust.json \\\n --description \u0026quot;${ACK_JOB_EXECUTION_IAM_ROLE_DESCRIPTION}\u0026quot;\n\nexport ACK_JOB_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name=$ACK_JOB_EXECUTION_ROLE --query Role.Arn --output text) \n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; job_policy.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;s3:PutObject\u0026quot;,\n \u0026quot;s3:GetObject\u0026quot;,\n \u0026quot;s3:ListBucket\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: \u0026quot;*\u0026quot;\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;s3:ListBucket\u0026quot;,\n \u0026quot;s3:GetObject*\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:s3:::tripdata\u0026quot;,\n \u0026quot;arn:aws:s3:::tripdata/*\u0026quot;\n ]\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;logs:PutLogEvents\u0026quot;,\n \u0026quot;logs:CreateLogStream\u0026quot;,\n \u0026quot;logs:DescribeLogGroups\u0026quot;,\n \u0026quot;logs:DescribeLogStreams\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:logs:*:*:*\u0026quot;\n ]\n }\n ]\n}\nEOF\necho \u0026quot;Creating ACK-${SERVICE}-JobExecution-POLICY\u0026quot;\naws iam create-policy \\\n --policy-name ack-${SERVICE}-jobexecution-policy \\\n --policy-document file://job_policy.json\n\necho -n \u0026quot;Attaching IAM policy ...\u0026quot;\naws iam attach-role-policy \\\n --role-name \u0026quot;${ACK_JOB_EXECUTION_ROLE}\u0026quot; \\\n --policy-arn \u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:policy/ack-${SERVICE}-jobexecution-policy\u0026quot;\n\naws emr-containers update-role-trust-policy \\\n --cluster-name ${EKS_CLUSTER_NAME} \\\n --namespace ${EMR_NAMESPACE} \\\n --role-name ${ACK_JOB_EXECUTION_ROLE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="run-a-sample-spark-job"\u003eRun a Sample Spark Job\u003c/h2\u003e\n\u003cp\u003eBefore running a sample job, let\u0026rsquo;s create CloudWatch Logs and an S3 bucket to store EMR on EKS logs\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport RANDOM_ID1=$(LC_ALL=C tr -dc a-z0-9 \u0026lt;/dev/urandom | head -c 8)\n\naws logs create-log-group --log-group-name=/emr-on-eks-logs/$EKS_CLUSTER_NAME\naws s3 mb s3://$EKS_CLUSTER_NAME-$RANDOM_ID1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow let\u0026rsquo;s submit sample spark job\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;checking if VirtualCluster Status is \u0026quot;True\u0026quot;\u0026quot;\nVC=$(kubectl get virtualcluster -o jsonpath=\'{.items..metadata.name}\')\nkubectl describe virtualcluster/$VC | yq e \'.Status.Conditions.Status\'\n\nexport RANDOM_ID2=$(LC_ALL=C tr -dc a-z0-9 \u0026lt;/dev/urandom | head -c 8)\n\ncat \u0026lt;\u0026lt; EOF \u0026gt; jobrun.yaml\n---\napiVersion: emrcontainers.services.k8s.aws/v1alpha1\nkind: JobRun\nmetadata:\n name: my-ack-jobrun-${RANDOM_ID2}\nspec:\n name: my-ack-jobrun-${RANDOM_ID2}\n virtualClusterRef:\n from:\n name: my-ack-vc\n executionRoleARN: \u0026quot;${ACK_JOB_EXECUTION_ROLE_ARN}\u0026quot;\n releaseLabel: \u0026quot;emr-6.7.0-latest\u0026quot;\n jobDriver:\n sparkSubmitJobDriver:\n entryPoint: \u0026quot;local:///usr/lib/spark/examples/src/main/python/pi.py\u0026quot;\n entryPointArguments:\n sparkSubmitParameters: \u0026quot;--conf spark.executor.instances=2 --conf spark.executor.memory=1G --conf spark.executor.cores=1 --conf spark.driver.cores=1\u0026quot;\n configurationOverrides: |\n ApplicationConfiguration: null\n MonitoringConfiguration:\n CloudWatchMonitoringConfiguration:\n LogGroupName: /emr-on-eks-logs/$EKS_CLUSTER_NAME\n LogStreamNamePrefix: pi-job\n S3MonitoringConfiguration:\n LogUri: s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 \nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;running sample job\u0026quot;\nkubectl apply -f jobrun.yaml\nkubectl describe jobruns\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eName: my-ack-jobrun-t2rpcpks\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: emrcontainers.services.k8s.aws/v1alpha1\nKind: JobRun\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:emr-containers:us-west-2:012345678910:/virtualclusters/dxnqujbxexzri28ph1wspbxo0/jobruns/000000030mrd934cdqc\n Owner Account ID: 012345678910\n Region: us-west-2\n Conditions:\n Last Transition Time: 2022-08-26T18:29:12Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Id: 000000030mrd934cdqc\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="cleanup"\u003eCleanup\u003c/h2\u003e\n\u003cp\u003eSimply run these commands to cleanup your environment\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e# delete all custom resources\nkubectl delete -f virtualcluster.yaml\nkubectl delete -f jobrun.yaml\n# note: you cannot delete jobruns until virtualcluster its mapped to is deleted\n\n# uninstall emrcontainers controller\nhelm delete ack-$SERVICE-controller -n $ACK_SYSTEM_NAMESPACE\n\n# delete namespace\nkubectl delete ns $ACK_SYSTEM_NAMESPACE\nkubectl delete ns $EMR_NAMESPACE\n\n# delete aws resources\naws logs delete-log-group --log-group-name=/emr-on-eks-logs/$EKS_CLUSTER_NAME\naws s3 rm s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 --recursive\naws s3 rb s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 \n\n# delete EKS cluster\neksctl delete cluster --name \u0026quot;${EKS_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="limitations"\u003eLimitations\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eYou cannot delete a JobRun unless its in \u003cstrong\u003eerror\u003c/strong\u003e state. There is no delete-job-run API for deleting jobs (for good reason). However, if your JobRun goes into error state, you can run \u003ccode\u003ekubectl delete jobrun/\u0026lt;job-run-name\u0026gt;\u003c/code\u003e to cancel the job.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="troubleshooting"\u003eTroubleshooting\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eIf you run into issues creating VirtualCluster or JobRuns, check EMR on EKS controller logs for troubleshooting\u003c/li\u003e\n\u003c/ul\u003e\n\u003cpre\u003e\u003ccode\u003eCONTROLLER_POD=$(kubectl get pod -n ${ACK_SYSTEM_NAMESPACE} -o jsonpath=\'{.items..metadata.name}\')\nkubectl logs ${CONTROLLER_POD} -n ${ACK_SYSTEM_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cul\u003e\n\u003cli\u003eYou can enable debug logs for EMR on EKS controller if you are unable to determine cause of the error. You need to change values for \u003ccode\u003eenable-development-logging\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and \u003ccode\u003e--log-level\u003c/code\u003e to \u003ccode\u003edebug\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cpre\u003e\u003ccode\u003eCONTROLLER_DEPLOYMENT=$(kubectl get deploy -n ${ACK_SYSTEM_NAMESPACE} -o jsonpath=\'{.items..metadata.name}\')\nkubectl edit deploy/${CONTROLLER_DEPLOYMENT} -n ${ACK_SYSTEM_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis is how your values should look after changes are applied.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e - --aws-region\n - $(AWS_REGION)\n - --aws-endpoint-url\n - $(AWS_ENDPOINT_URL)\n - --enable-development-logging\n - \u0026quot;true\u0026quot;\n - --log-level\n - debug\n - --resource-tags\n - $(ACK_RESOURCE_TAGS)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cul\u003e\n\u003cli\u003eIf you run into any issue, please create \u003ca href="https://github.com/aws-controllers-k8s/community/issues"\u003eGithub issue\u003c/a\u003e. Click \u003cstrong\u003eNew issue\u003c/strong\u003e and select the type of issue, add \u003ccode\u003e[emr-containers] \u0026lt;highlevel overview\u0026gt;\u003c/code\u003e under title, and add enough details so that we can reproduce and provide a response\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:29,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/building-controller/",title:"Building a Controller",description:"How to build or regenerate an ACK service controller",content:'\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eYou should have forked the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\nrepository and \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d it locally when \u003ca href="../setup"\u003esetting up\u003c/a\u003e your\ndevelopment environment,\u003c/p\u003e\n\u003cp\u003eWith the prerequisites out of the way, let\u0026rsquo;s move on to the first step:\nbuilding the code generator.\u003c/p\u003e\n\u003ch2 id="build-code-generator"\u003eBuild code generator\u003c/h2\u003e\n\u003cp\u003eBuilding an ACK service controller (or regenerating an existing one from a\nnewer API model file) requires the \u003ccode\u003eack-generate\u003c/code\u003e binary, which is the main\ncode generator CLI tool.\u003c/p\u003e\n\u003cp\u003eTo build the latest \u003ccode\u003eack-generate\u003c/code\u003e binary, execute the following command from\nthe root directory of the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\nsource repository:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake build-ack-generate\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n One-off build\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n You only have to do this once, overall. In other words: unless we change\nsomething upstream in terms of the code generation process, this is\na one-off operation. Internally, the Makefile executes an \u003ccode\u003ego build\u003c/code\u003e here.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eDon\u0026rsquo;t worry if you forget this step, the script in the next step will complain\nwith a message along the line of \u003ccode\u003eERROR: Unable to find an ack-generate binary\u003c/code\u003e\nand will give you another opportunity to rectify the situation.\u003c/p\u003e\n\u003ch2 id="build-an-ack-service-controller"\u003eBuild an ACK service controller\u003c/h2\u003e\n\u003cp\u003eNow that we have the basic code generation step done we will create the\nrespective ACK service controller and its supporting artifacts.\u003c/p\u003e\n\u003cp\u003eSo first you have to select a service that you want to build and test.\nYou do that by setting the \u003ccode\u003eSERVICE\u003c/code\u003e environment variable. Let\u0026rsquo;s say we want\nto test the S3 service (creating an S3 bucket), so we would execute the\nfollowing:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we are in a position to generate the ACK service controller for the S3 API.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake build-controller SERVICE=$SERVICE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBy default, running \u003ccode\u003emake build-controller\u003c/code\u003e will output the generated code to\nACK service controller for S3\u0026rsquo;s source code repository (the\n\u003ccode\u003e$GOPATH/src/github.com/aws-controllers-k8s/s3-controller\u003c/code\u003e directory). You can\noverride this behaviour with the \u003ccode\u003eSERVICE_CONTROLLER_SOURCE_PATH\u003c/code\u003e environment\nvariable.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Handle \u003ccode\u003econtroller-gen: command not found\u003c/code\u003e\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you run into the \u003ccode\u003econtroller-gen: command not found\u003c/code\u003e message when\nexecuting \u003ccode\u003emake build-controller\u003c/code\u003e then you want to check if the\n\u003ccode\u003econtroller-gen\u003c/code\u003e binary is available in \u003ccode\u003e$GOPATH/bin\u003c/code\u003e, also ensure that \u003ccode\u003e$GOPATH/bin\u003c/code\u003e is part of your \u003ccode\u003e$PATH\u003c/code\u003e, see also\n\u003ca href="https://github.com/aws/aws-controllers-k8s/issues/234"\u003e\u003ccode\u003e#234\u003c/code\u003e\u003c/a\u003e.\nYou can also install the required version of \u003ccode\u003econtroller-gen\u003c/code\u003e using the\n\u003ccode\u003escripts/install-controller-gen.sh\u003c/code\u003e helper script.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn addition to the ACK service controller code, above generates the\ncustom resource definition (CRD) manifests as well as the necessary RBAC\nsettings using the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/scripts/build-controller.sh"\u003e\u003ccode\u003e/scripts/build-controller.sh\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that we have the generation part completed, we want to see if the\ngenerated artifacts indeed are able to create an S3 bucket for us.\u003c/p\u003e\n\u003cp\u003eLearn about how to \u003ca href="../testing"\u003erun e2e tests for an ACK controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:30,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/cross-account-resource-management/",title:"Manage Resources In Multiple AWS Accounts",description:"Managing resources in different AWS accounts",content:'\u003cp\u003eACK service controllers can manage resources in different AWS accounts. To enable and start using this feature, as an administrator, you will need to:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eConfigure the AWS accounts where the resources will be managed\u003c/li\u003e\n\u003cli\u003eMap AWS accounts with the Role ARNs that need to be assumed\u003c/li\u003e\n\u003cli\u003eAnnotate namespaces with AWS Account IDs\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eFor detailed information about how ACK service controllers manage resources in multiple AWS accounts, please refer to the Cross-Account Resource Management (CARM) \u003ca href="https://github.com/aws-controllers-k8s/community/blob/main/docs/design/proposals/carm/cross-account-resource-management.md"\u003edesign document\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-note"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n To use CARM, \u003ccode\u003e--watch-namespace\u003c/code\u003e must be empty\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK service controllers may be started in either Cluster Mode or Namespace Mode. When a service controller is started in Namespace Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag is supplied and the controller will \u003cem\u003eonly\u003c/em\u003e watch for custom resources (CRs) in that Kubernetes Namespace. Because the cross-account resource management feature requires the controller to watch for custom resources on many Kubernetes Namespaces, this feature is incompatible with the Namespace Mode of running a controller and thus the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag must not be set (or be set to an empty string).\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="step-1-configure-your-aws-accounts"\u003eStep 1: Configure your AWS accounts\u003c/h2\u003e\n\u003cp\u003eAWS account administrators should create and configure IAM roles to allow ACK service controllers to assume roles in different AWS accounts.\u003c/p\u003e\n\u003cp\u003eTo allow account A (000000000000) to create AWS S3 buckets in account B (111111111111), you can use the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Using account B credentials\naws iam create-role --role-name s3FullAccess \\\n --assume-role-policy-document \'{\u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\u0026quot;Statement\u0026quot;: [{ \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;, \u0026quot;Principal\u0026quot;: {\u0026quot;AWS\u0026quot;: \u0026quot;arn:aws:iam::000000000000:role/roleA-production\u0026quot;}, \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;}]}\'\naws iam attach-role-policy --role-name s3FullAccess \\\n --policy-arn \'arn:aws:iam::aws:policy/service-role/AmazonS3FullAccess\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-2-map-aws-accounts-to-their-associated-role-arns"\u003eStep 2: Map AWS accounts to their associated role ARNs\u003c/h2\u003e\n\u003cp\u003eCreate a \u003ccode\u003eConfigMap\u003c/code\u003e to associate each AWS Account ID with the role ARN that needs to be assumed in order to manage resources in that particular account.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ack-role-account-map\n namespace: $ACK_SYSTEM_NAMESPACE\ndata:\n \u0026quot;111111111111\u0026quot;: arn:aws:iam::111111111111:role/s3FullAccess\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-3-bind-accounts-to-namespaces"\u003eStep 3: Bind accounts to namespaces\u003c/h2\u003e\n\u003cp\u003eTo bind AWS accounts to a specific namespace you will have to annotate the namespace with an AWS account ID. For example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: Namespace\nmetadata:\n name: production\n annotations:\n services.k8s.aws/owner-account-id: \u0026quot;111111111111\u0026quot;\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor existing namespaces, you can run:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl annotate namespace production services.k8s.aws/owner-account-id=111111111111\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-resources-in-different-aws-accounts"\u003eCreate resources in different AWS accounts\u003c/h3\u003e\n\u003cp\u003eNext, create your custom resources (CRs) in the associated namespace.\u003c/p\u003e\n\u003cp\u003eFor example, to create an S3 bucket in account B, run the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n namespace: production\nspec:\n name: my-bucket\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eCheckout the \u003ca href="../authorization"\u003eRBAC and IAM permissions overview\u003c/a\u003e to understand how ACK manages authorization\u003c/p\u003e\n'}).add({id:31,href:"https://aws-controllers-k8s.github.io/community/docs/community/releases/",title:"Release Phases",description:"Releases, Versioning and Maintenance Phases",content:'\u003cp\u003eService controllers are built in separate source code repositories. Below, you\nwill find a description of the \u003ca href="#project-stages"\u003eProject Stages\u003c/a\u003e that a service\ncontroller repository goes through on its way to being released.\u003c/p\u003e\n\u003cp\u003eA controller that has reached the \u003ccode\u003eRELEASED\u003c/code\u003e project stage will have a set of\nrelease artifacts, including binary container images for the controller and a Helm\nChart that installs the controller into a target Kubernetes cluster. Read more\nbelow about our \u003ca href="#releases-and-versioning"\u003eReleases and Versioning policy\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFinally, we have a set of documented \u003ca href="#maintenance-phases"\u003eMaintenance Phases\u003c/a\u003e\nthat clearly outline our support stance for service controllers that have been\nreleased.\u003c/p\u003e\n\u003ch2 id="project-stages"\u003eProject Stages\u003c/h2\u003e\n\u003cp\u003eThe controller\u0026rsquo;s \u0026ldquo;project stage\u0026rdquo; describes how far along the controller is\ntowards being released:\u003c/p\u003e\n\u003cp\u003e\u003ca href="#proposed"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#planned"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#in-progress"\u003e\u003ccode\u003eIN PROGRESS\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#released"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\u003ch3 id="proposed"\u003ePROPOSED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003ePROPOSED\u003c/code\u003e stage indicates that there is expressed interest in supporting\nan AWS service in ACK.\u003c/p\u003e\n\u003cp\u003eAt this stage, there will be a Github Issue and/or a Github Project for\ntracking the creation of the ACK service controller for the service.\u003c/p\u003e\n\u003cp\u003eThe GitHub Issue \u003cstrong\u003eWILL NOT\u003c/strong\u003e be associated with a GitHub Milestone.\u003c/p\u003e\n\u003ch3 id="planned"\u003ePLANNED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003ePLANNED\u003c/code\u003e stage indicates that we plan to make a controller for this\nservice available in ACK.\u003c/p\u003e\n\u003cp\u003eAt this stage, there \u003cstrong\u003eWILL BE\u003c/strong\u003e a GitHub Milestone that tracks progress\ntowards the release of the controller.\u003c/p\u003e\n\u003ch3 id="in-progress"\u003eIN PROGRESS\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003eIN PROGRESS\u003c/code\u003e stage indicates that the ACK service controller for the AWS\nservice is \u003cstrong\u003eactively being built\u003c/strong\u003e in preparation for a release of that ACK\nservice controller.\u003c/p\u003e\n\u003cp\u003eIn the \u003ccode\u003eIN PROGRESS\u003c/code\u003e stage we identify those \u003cstrong\u003eAWS service API resources\u003c/strong\u003e that\nwill be supported by the controller and generate the code that manages the\nlifecycle of these resources.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n What do we mean by \u0026lsquo;AWS service API resources\u0026rsquo;?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n An \u003cem\u003eAWS service API resource\u003c/em\u003e is a top-level object that can be created by\na particular AWS service API. For example, an SNS Topic or an S3 Bucket.\nSome service APIs have multiple top-level resources; SNS, for instance, has\nTopic, PlatformApplication and PlatformEndpoint top-level resources that\nmay be created.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="released"\u003eRELEASED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003eRELEASED\u003c/code\u003e project stage indicates that the ACK service controller source\nrepository has had a Semantic Versioning Git tag applied and that both a container\nimage and Helm Chart have been built and published to the ECR Public\nrepositories for ACK.\u003c/p\u003e\n\u003cp\u003eOnce a service controller reaches the \u003ccode\u003eRELEASED\u003c/code\u003e project stage, that \u003cstrong\u003edoes not\nmean\u003c/strong\u003e that there can never be any changes or additions to the Custom Resource\nDefinitions (CRDs) or public interfaces exposed by that service controller. The\n\u003ccode\u003eRELEASED\u003c/code\u003e project stage is simply an indication that there is at least one\nSemVer-tagged binary release of the controller.\u003c/p\u003e\n\u003cp\u003eConsumers should look to the SemVer release tag as an indication of whether\ncode included in that release introduces new breaking (major version increment)\nor non-breaking features (minor version increment) or simply bug fixes (patch\nversion increment). Consumers should see release notes for a release tag for a\nfull description of changes included in that release.\u003c/p\u003e\n\u003ch2 id="releases-and-versioning"\u003eReleases and Versioning\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-danger"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Important\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK does \u003cem\u003enot\u003c/em\u003e have a single release status or version.\nDifferent components within the ACK project have different release cadences,\nversions and statuses. Please read the information below before installing\nany ACK component.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eService controllers in ACK use \u003ca href="#semantic-versioning"\u003eSemantic Versioning\u003c/a\u003e to\nindicate whether changes included in a particular binary release introduce\nfeatures or bug fixes and whether or not features break backwards compatibility\nfor public APIs and interfaces.\u003c/p\u003e\n\u003cp\u003eThere are two release artifacts produced when an ACK service controller is\nreleased: a binary \u003cstrong\u003econtainer image\u003c/strong\u003e with the controller and a \u003cstrong\u003eHelm Chart\u003c/strong\u003e\nthat installs the controller into a target Kubernetes cluster. Both these\nartifacts will have tags that correspond to the Semantic Version Git tag\napplied against the source code repository for the controller.\u003c/p\u003e\n\u003ch3 id="semantic-versioning"\u003eSemantic Versioning\u003c/h3\u003e\n\u003cp\u003eACK is a collection of custom Kubernetes controllers, one for each supported\nAWS API. Each ACK controller is composed of an \u003ca href="https://github.com/aws-controllers-k8s/runtime"\u003eACK common runtime\u003c/a\u003e and\nGo code that links the Kubernetes API and the AWS API. Much of this Go code is\ngenerated by the \u003ca href="https://github.com/aws-controllers-k8s/code-generator"\u003e\u003ccode\u003eack-generate\u003c/code\u003e\u003c/a\u003e tool; some of the Go code is\nhand-crafted.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAll code components\u003c/strong\u003e in ACK use \u003ca href="https://semver.org/"\u003eSemantic Versioning\u003c/a\u003e (SemVer) as a\nsignal to consumers whether public interfaces or APIs have breaking changes.\u003c/p\u003e\n\u003cp\u003eWhen an ACK component is \u003cem\u003e\u003cstrong\u003ereleased\u003c/strong\u003e\u003c/em\u003e, a Git tag containing a SemVer (X.Y.Z)\nis created on the component\u0026rsquo;s source repository. If the commits to the source\nrepository in between the last Git tag and the commit being tagged have\nintroduced changes that break public-facing APIs or interfaces, the SemVer will\nhave its major version (\u0026ldquo;X\u0026rdquo;) incremented. If the commits introduce\nfunctionality that does not break interfaces or APIs, the minor version (\u0026ldquo;Y\u0026rdquo;)\nwill be incremented. If the commits simply fix bugs and do not introduce any\nfeatures or interface changes, the patch version (\u0026ldquo;Z\u0026rdquo;) will be incremented.\u003c/p\u003e\n\u003cp\u003eReleases of any ACK component that have a zero major release number (e.g.\n\u003ccode\u003e0.0.2\u003c/code\u003e) may have breaking changes to the public API or interfaces exposed by\nthat component.\u003c/p\u003e\n\u003cp\u003eThis is by design, and \u003ca href="https://semver.org/#spec-item-4"\u003eper the Semantic Versioning specification\u003c/a\u003e:\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003eMajor version zero (0.y.z) is for initial development. Anything MAY change at\nany time. The public API SHOULD NOT be considered stable.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eFor ACK components that have a binary distributable \u0026ndash; i.e. a container image \u0026ndash;\nthe creation of a new SemVer Git tag on the source code repository triggers the\nautomatic building and publishing of a container image with an image tag including\nthe SemVer version.\u003c/p\u003e\n\u003cp\u003eFor example, if a Git tag of \u003ccode\u003ev1.2.6\u003c/code\u003e was created on the\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/a\u003e repository, a container\nimage with a tag \u003ccode\u003e1.2.6\u003c/code\u003e would be published to the\n\u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-controller"\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller\u003c/a\u003e ECR Public\nrepository.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Binaries for individual ACK service controllers components are published in\nseparate Amazon ECR Public repositories.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eFor ACK components that have a Helm Chart distributable \u0026ndash; i.e. an ACK service\ncontroller \u0026ndash; the creation of a new SemVer Git tag on the source code\nrepository triggers automatic building and publishing of a Helm Chart with\nan artifact tag including the SemVer version.\u003c/p\u003e\n\u003cp\u003eFor example, a Git tag of \u003ccode\u003ev1.2.6\u003c/code\u003e on the\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/a\u003e\nrepository means a Helm chart with a tag \u003ccode\u003e1.2.6\u003c/code\u003e would be published to the\n\u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-chart"\u003epublic.ecr.aws/aws-controllers-k8s/s3-chart\u003c/a\u003e ECR Public\nrepository.\u003c/p\u003e\n\u003ch4 id="a-word-about-dependencies"\u003eA Word About Dependencies\u003c/h4\u003e\n\u003cp\u003eEach service-specific ACK controller \u0026ndash; e.g. the ElastiCache ACK controller \u0026ndash;\ndepends on a specific version of the ACK common runtime. This dependency is\nspecified in the controller\u0026rsquo;s \u003ccode\u003ego.mod\u003c/code\u003e file.\u003c/p\u003e\n\u003cp\u003eThe ACK code generator that produces Go code for service controllers depends on\na specific version of the ACK common runtime.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Dependency between the code generator and common runtime\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The ACK code generator depends on the ACK common runtime in a unique way:\nthe Go code that the ACK code generator \u003cem\u003eproduces\u003c/em\u003e adheres to a specific\nversion of the ACK common runtime. Even though no Go code in the ACK code\ngenerator actually imports the ACK common runtime, this dependency exists\nbecause the Go code produced by the templates inside the code generator imports\nthe ACK common runtime. In order to make this Go code dependency more strict,\nwe have a test package inside the ACK code generator that imports the ACK\ncommon runtime. In this way, we\u0026rsquo;re able to include a version-specific\ndependency line in the ACK code generator\u0026rsquo;s \u003ccode\u003ego.mod\u003c/code\u003e file, thereby allowing\nGo\u0026rsquo;s module infrastructure to pin the dependency between the code generator and\nthe common runtime.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="maintenance-phases"\u003eMaintenance Phases\u003c/h2\u003e\n\u003cp\u003eAs noted above, individual ACK service controllers all use Semantic Versioning\n(\u0026ldquo;X.Y.Z\u0026rdquo;) in order to signal breaking interface changes. However, each\ncontroller follows its own release cadence and each controller has a separate\nteam of contributors that maintain the code, test the controller and determine\nwhether the controller is stable in long-running operation.\u003c/p\u003e\n\u003cp\u003eACK service controllers having release tags within a major Semantic Version\n(\u0026ldquo;X\u0026rdquo;) will be in one of four Maintenance Phases:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#preview"\u003ePREVIEW\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="#general-availability"\u003eGENERAL AVAILABILITY\u003c/a\u003e (GA)\u003c/li\u003e\n\u003cli\u003e\u003ca href="#deprecated"\u003eDEPRECATED\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="#not-supported"\u003eNOT SUPPORTED\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="preview"\u003ePreview\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003ePreview\u003c/code\u003e Maintenance Phase are released for testing by\nusers and are not recommended for production use.\u003c/p\u003e\n\u003cp\u003eFor \u003ccode\u003ePreview\u003c/code\u003e controllers, we ask users to submit bug reports using Github\nIssues and we will do our best to remediate problems in a timely manner.\u003c/p\u003e\n\u003ch3 id="general-availability"\u003eGeneral Availability\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e (GA) Maintenance Phase have been\nthrough long-running \u0026ldquo;soak\u0026rdquo; tests and are recommended for production use by the\nteam maintaining that controller.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e Maintenance Phase will have a\nHelm Chart tagged with the major version \u0026gt;0 (eg. \u003ccode\u003e1.0.0\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eUsers who submit bug reports using Github Issues that reference a \u003ccode\u003eGeneral Availability\u003c/code\u003e controller will have their bug reports prioritized by the\ncontributor team maintaining that controller.\u003c/p\u003e\n\u003ch3 id="deprecated"\u003eDeprecated\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e Maintenance Phase may move to a\n\u003ccode\u003eDeprecated\u003c/code\u003e Maintenance Phase after a Deprecation Warning notice has been sent\nout (and the controller\u0026rsquo;s documentation has been updated with said deprecation\nnotice).\u003c/p\u003e\n\u003cp\u003eControllers in \u003ccode\u003eDeprecated\u003c/code\u003e Maintenance Phase continue to receive the same\nlevel of support as controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e phase.\u003c/p\u003e\n\u003ch3 id="not-supported"\u003eNot Supported\u003c/h3\u003e\n\u003cp\u003eACK controllers may eventually be moved into a \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase.\u003c/p\u003e\n\u003cp\u003eA controller major version series may move from the \u003ccode\u003ePreview\u003c/code\u003e Maintenance Phase\nto the \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase at any time. This may happen if the\nteam maintaining the controller determines it is not possible to get the\ncontroller with that major version series into a \u003ccode\u003eGeneral Availability\u003c/code\u003e phase.\u003c/p\u003e\n\u003cp\u003eA controller major version series may move from the \u003ccode\u003eDeprecated\u003c/code\u003e\nMaintenance Phase to the \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase \u003cem\u003eonly after a 1-year\ndeprecation period has elapsed\u003c/em\u003e.\u003c/p\u003e\n'}).add({id:32,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/drift-recovery/",title:"Recovering from Drift",description:"Recovering from Drift",content:'\u003cp\u003eKubernetes controllers work on the principal of \u003ca href="https://book.kubebuilder.io/cronjob-tutorial/controller-overview.html#whats-in-a-controller"\u003econstant\nreconciliation\u003c/a\u003e. In essence, they continuously look at\nthe current desired state of the system and compare it to the actual state,\nusing the difference to determine the action required to get to the desired end\nresult.\u003c/p\u003e\n\u003cp\u003eOnce a controller has reconciled a resource to its desired state, the controller\nshouldn\u0026rsquo;t need to continue reconciling - the actual state of the resource meets\nthe specification. However, this is only true for closed systems, where the\ncontroller is the only actor interacting with a resource. Unfortunately, ACK\ncontrollers don\u0026rsquo;t act in a closed system. ACK controllers are not the only actor\ncapable of modifying the actual state of any AWS resources - other programs, or\neven people, may have their own privileges. When another actor modifies a\nresource after the ACK controller has reconciled it to its desired state, that\u0026rsquo;s\ncalled \u0026ldquo;drift\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eACK controllers detect drift by continuing to reconcile resources after they\nhave reached their desired state, but with much longer delays between\nreconciliation attempts. By default, all ACK controllers attempt to detect drift\nonce every \u003cstrong\u003e10 hours\u003c/strong\u003e. That is, every 10 hours after a resource has been\nmarked with the \u003ccode\u003eResourceSynced = true\u003c/code\u003e condition, its owner controller will\ndescribe the resource in AWS to see if it no longer matches the desired state.\nIf the controller detects a difference, it then starts the reconciliation loop\nagain to get back to that state (just as when any other change has been made).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Existing resource overrides\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eSome resources require more frequent drift remediation. For example, if a\nresource runs a stateful workload whose status changes frequently (such as a\nSageMaker \u003ccode\u003eTrainingJob\u003c/code\u003e). For these resources, the drift remediation period may\nalready have been decreased by the controller authors to improve the\nresponsiveness of the resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eAll override periods are logged to stdout when the controller is started.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="overriding-the-drift-remediation-period"\u003eOverriding the drift remediation period\u003c/h2\u003e\n\u003ch3 id="for-all-resources-owned-by-a-controller"\u003eFor all resources owned by a controller\u003c/h3\u003e\n\u003cp\u003eIf you would like to decrease the drift remediation period for \u003cem\u003eall\u003c/em\u003e resources\nowned by a controller, update the \u003ccode\u003ereconcile.defaultResyncPeriod\u003c/code\u003e value in the\nHelm chart \u003ccode\u003evalues.yaml\u003c/code\u003e file with the number of seconds for the new period,\nlike so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ereconcile:\n defaultResyncPeriod: 1800 # 30 minutes (in seconds)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="for-a-single-resource-type"\u003eFor a single resource type\u003c/h3\u003e\n\u003cp\u003eThe most granular configuration for setting reconciliation periods is to apply\nit to all resources of a given type. For example, all S3 \u003ccode\u003eBucket\u003c/code\u003e managed by a\nsingle controller.\u003c/p\u003e\n\u003cp\u003eAdd the resource name and the overriding period (in seconds) to the\n\u003ccode\u003ereconcile.resourceResyncPeriods\u003c/code\u003e value in the Helm chart \u003ccode\u003evalues.yaml\u003c/code\u003e like\nso:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ereconcile:\n resourceResyncPeriods:\n Bucket: 1800 # 30 minutes (in seconds)\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:33,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generator-config/",title:"Understanding generator.yaml configuration",description:"Understanding the ACK generator.yaml configuration file",content:'\u003ch1 id="understanding-generatoryaml-configuration"\u003eUnderstanding generator.yaml Configuration\u003c/h1\u003e\n\u003cp\u003eThis document describes the various configuration fields in a \u003ccode\u003egenerator.yaml\u003c/code\u003e file that can be used to control the API inference and code generation for an ACK controller.\u003c/p\u003e\n\u003cp\u003eWe will show examples of configuring specific ACK controllers to highlight various configuration options.\u003c/p\u003e\n\u003ch2 id="generate-a-resource-manager-package"\u003eGenerate a resource manager package\u003c/h2\u003e\n\u003cp\u003eFor this section, we will use \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html"\u003eECR\u003c/a\u003e as our example service API.\u003c/p\u003e\n\u003cp\u003eWhen creating a new ACK controller, after running the \u003ca href="https://github.com/aws-controllers-k8s/controller-bootstrap"\u003e\u003ccode\u003econtroller-bootstrap\u003c/code\u003e\u003c/a\u003e program, you will be left with a \u003ccode\u003egenerator.yaml\u003c/code\u003e that has all inferred API resources ignored.\u003c/p\u003e\n\u003cp\u003eFor the ECR controller, the \u003ccode\u003egenerator.yaml\u003c/code\u003e file would look like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n - Repository\n - PullThroughCacheRule\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf we ran \u003ccode\u003emake build-controller SERVICE=ecr\u003c/code\u003e with the above \u003ccode\u003egenerator.yaml\u003c/code\u003e file, we would have some basic directories and files created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash="\u003e[jaypipes@thelio code-generator]$ make build-controller SERVICE=ecr\nbuilding ack-generate ... ok.\n==== building ecr-controller ====\nCopying common custom resource definitions into ecr\nBuilding Kubernetes API objects for ecr\nGenerating deepcopy code for ecr\nGenerating custom resource definitions for ecr\nBuilding service controller for ecr\nGenerating RBAC manifests for ecr\nRunning gofmt against generated code for ecr\nUpdating additional GitHub repository maintenance files\n==== building ecr-controller release artifacts ====\nBuilding release artifacts for ecr-v0.0.0-non-release\nGenerating common custom resource definitions\nGenerating custom resource definitions for ecr\nGenerating RBAC manifests for ecr\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio ecr-controller]$ tree apis/ config/ pkg/\napis/\n└── v1alpha1\n ├── ack-generate-metadata.yaml\n ├── doc.go\n ├── enums.go\n ├── generator.yaml\n ├── groupversion_info.go\n └── types.go\nconfig/\n├── controller\n│ ├── deployment.yaml\n│ ├── kustomization.yaml\n│ └── service.yaml\n├── crd\n│ ├── common\n│ │ ├── bases\n│ │ │ ├── services.k8s.aws_adoptedresources.yaml\n│ │ │ └── services.k8s.aws_fieldexports.yaml\n│ │ └── kustomization.yaml\n│ └── kustomization.yaml\n├── default\n│ └── kustomization.yaml\n├── overlays\n│ └── namespaced\n│ ├── kustomization.yaml\n│ ├── role-binding.json\n│ └── role.json\n└── rbac\n ├── cluster-role-binding.yaml\n ├── cluster-role-controller.yaml\n ├── kustomization.yaml\n ├── role-reader.yaml\n ├── role-writer.yaml\n └── service-account.yaml\npkg/\n├── resource\n│ └── registry.go\n└── version\n └── version.go\n\n11 directories, 25 files\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo begin generating a particular resource manager, comment out the name of the resource from the ignore list and run \u003ccode\u003emake build-controller SERVICE=$SERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n\u0026gt; #- Repository\n - PullThroughCacheRule\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter doing so, the resource manager for \u003ccode\u003eRepository\u003c/code\u003e resources will have been generated in the \u003ccode\u003eecr-controller\u003c/code\u003e source code repository.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio ecr-controller]$ tree apis/ config/ pkg/\napis/\n└── v1alpha1\n ├── ack-generate-metadata.yaml\n ├── doc.go\n ├── enums.go\n ├── generator.yaml\n ├── groupversion_info.go\n ├── repository.go\n ├── types.go\n └── zz_generated.deepcopy.go\nconfig/\n├── controller\n│ ├── deployment.yaml\n│ ├── kustomization.yaml\n│ └── service.yaml\n├── crd\n│ ├── bases\n│ │ └── ecr.services.k8s.aws_repositories.yaml\n│ ├── common\n│ │ ├── bases\n│ │ │ ├── services.k8s.aws_adoptedresources.yaml\n│ │ │ └── services.k8s.aws_fieldexports.yaml\n│ │ └── kustomization.yaml\n│ └── kustomization.yaml\n├── default\n│ └── kustomization.yaml\n├── overlays\n│ └── namespaced\n│ ├── kustomization.yaml\n│ ├── role-binding.json\n│ └── role.json\n└── rbac\n ├── cluster-role-binding.yaml\n ├── cluster-role-controller.yaml\n ├── kustomization.yaml\n ├── role-reader.yaml\n ├── role-writer.yaml\n └── service-account.yaml\npkg/\n├── resource\n│ ├── registry.go\n│ └── repository\n│ ├── delta.go\n│ ├── descriptor.go\n│ ├── identifiers.go\n│ ├── manager_factory.go\n│ ├── manager.go\n│ ├── references.go\n│ ├── resource.go\n│ ├── sdk.go\n│ └── tags.go\n└── version\n └── version.go\n\n13 directories, 37 files\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote the new files under \u003ccode\u003epkg/resource/repository/\u003c/code\u003e, \u003ccode\u003eapis/v1alpha1/repository.go\u003c/code\u003e and \u003ccode\u003econfig/crd/bases/\u003c/code\u003e. These files represent the Go type for the generated \u003ccode\u003eRepository\u003c/code\u003e custom resource definition (CRD), the resource manager package and the YAML representation for the CRD, respectively.\u003c/p\u003e\n\u003ch2 id="renames-renaming-things"\u003e\u003ccode\u003erenames\u003c/code\u003e: Renaming things\u003c/h2\u003e\n\u003cp\u003eWhy might we want to rename fields or resources? Generally, there are two reasons for this:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ereducing stutter in the input shape\u003c/li\u003e\n\u003cli\u003ecorrecting instances where a field is named differently in the input and output shapes\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe first reason is to reduce \u0026ldquo;stutter\u0026rdquo; (or redundancy) in naming. For example, the ECR \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L2"\u003e\u003ccode\u003eRepository\u003c/code\u003e\u003c/a\u003e resource has a field called \u003ccode\u003eRepositoryName\u003c/code\u003e. This field is redundantly named because the resource itself is called \u003ccode\u003eRepository\u003c/code\u003e. Every Kubernetes object has a \u003ccode\u003eMetadata.Name\u003c/code\u003e field and we like to align resource \u0026ldquo;name fields\u0026rdquo; with this simple \u003ccode\u003eName\u003c/code\u003e moniker.\u003c/p\u003e\n\u003cp\u003eFor this example, let\u0026rsquo;s go ahead and \u0026ldquo;destutter\u0026rdquo; the \u003ccode\u003eRepositoryName\u003c/code\u003e field. To do this, we use the \u003ccode\u003erenames\u003c/code\u003e configuration option, specifying the input and output shapes and their members that we want to rename:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\nresources:\n Repository:\n\u0026gt; renames:\n\u0026gt; operations:\n\u0026gt; CreateRepository:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u0026gt; DeleteRepository:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u0026gt; DescribeRepositories:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u003c/code\u003e\u003c/pre\u003e\n\u003cblockquote\u003e\n\u003cp\u003e📝 Note that we must tell the code generator which fields to rename in the input shapes for each API operation that the resource manager will call. In the case of ECR \u003ccode\u003eRepository\u003c/code\u003e resources, the resource manager calls the \u003ccode\u003eCreateRepository\u003c/code\u003e, \u003ccode\u003eDeleteRepository\u003c/code\u003e and \u003ccode\u003eDescribeRepositories\u003c/code\u003e API calls and so we need specify the \u003ccode\u003eRepositoryName\u003c/code\u003e member field in each of those input shapes should be renamed to \u003ccode\u003eName\u003c/code\u003e.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eAfter calling \u003ccode\u003emake build-controller SERVICE=ecr\u003c/code\u003e, we see the above generator configuration items produced the following diff:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-diff="\u003ediff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml\nindex e34e029..f214b43 100755\n--- a/apis/v1alpha1/ack-generate-metadata.yaml\n+++ b/apis/v1alpha1/ack-generate-metadata.yaml\n@@ -1,13 +1,13 @@\n ack_generate_info:\n- build_date: \u0026quot;2022-11-09T20:15:42Z\u0026quot;\n+ build_date: \u0026quot;2022-11-09T20:16:52Z\u0026quot;\n build_hash: 5ee0ac052c54f008dff50f6f5ebb73f2cf3a0bd7\n go_version: go1.18.1\n version: v0.20.1-4-g5ee0ac0\n-api_directory_checksum: 0a514bef9cff983f9fe28f080d85725ccf578060\n+api_directory_checksum: 84fb59a0991980da922a385f585111a1ff784d82\n api_version: v1alpha1\n aws_sdk_go_version: v1.44.93\n generator_config_info:\n- file_checksum: 87446926d73abae9355e6328eb7f8f668b16b18e\n+ file_checksum: a383007f82a686dc544879792dde7b091aeededa\n original_file_name: generator.yaml\n last_modification:\n reason: API generation\ndiff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml\nindex cb7045a..ed0130f 100644\n--- a/apis/v1alpha1/generator.yaml\n+++ b/apis/v1alpha1/generator.yaml\n@@ -2,3 +2,16 @@ ignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\n+resources:\n+ Repository:\n+ renames:\n+ operations:\n+ CreateRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DeleteRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DescribeRepositories:\n+ input_fields:\n+ RepositoryName: Name\ndiff --git a/apis/v1alpha1/repository.go b/apis/v1alpha1/repository.go\nindex c226d4f..fc6165d 100644\n--- a/apis/v1alpha1/repository.go\n+++ b/apis/v1alpha1/repository.go\n@@ -35,15 +35,15 @@ type RepositorySpec struct {\n // be overwritten. If IMMUTABLE is specified, all image tags within the repository\n // will be immutable which will prevent them from being overwritten.\n ImageTagMutability *string `json:\u0026quot;imageTagMutability,omitempty\u0026quot;`\n- // The Amazon Web Services account ID associated with the registry to create\n- // the repository. If you do not specify a registry, the default registry is\n- // assumed.\n- RegistryID *string `json:\u0026quot;registryID,omitempty\u0026quot;`\n // The name to use for the repository. The repository name may be specified\n // on its own (such as nginx-web-app) or it can be prepended with a namespace\n // to group the repository into a category (such as project-a/nginx-web-app).\n // +kubebuilder:validation:Required\n- RepositoryName *string `json:\u0026quot;repositoryName\u0026quot;`\n+ Name *string `json:\u0026quot;name\u0026quot;`\n+ // The Amazon Web Services account ID associated with the registry to create\n+ // the repository. If you do not specify a registry, the default registry is\n+ // assumed.\n+ RegistryID *string `json:\u0026quot;registryID,omitempty\u0026quot;`\n // The metadata that you apply to the repository to help you categorize and\n // organize them. Each tag consists of a key and an optional value, both of\n // which you define. Tag keys can have a maximum character length of 128 characters,\ndiff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go\nindex 93919be..88dd4c0 100644\n--- a/apis/v1alpha1/zz_generated.deepcopy.go\n+++ b/apis/v1alpha1/zz_generated.deepcopy.go\n@@ -421,13 +421,13 @@ func (in *RepositorySpec) DeepCopyInto(out *RepositorySpec) {\n *out = new(string)\n **out = **in\n }\n- if in.RegistryID != nil {\n- in, out := \u0026amp;in.RegistryID, \u0026amp;out.RegistryID\n+ if in.Name != nil {\n+ in, out := \u0026amp;in.Name, \u0026amp;out.Name\n *out = new(string)\n **out = **in\n }\n- if in.RepositoryName != nil {\n- in, out := \u0026amp;in.RepositoryName, \u0026amp;out.RepositoryName\n+ if in.RegistryID != nil {\n+ in, out := \u0026amp;in.RegistryID, \u0026amp;out.RegistryID\n *out = new(string)\n **out = **in\n }\ndiff --git a/config/crd/bases/ecr.services.k8s.aws_repositories.yaml b/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\nindex 438785e..9657569 100644\n--- a/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\n+++ b/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\n@@ -61,17 +61,17 @@ spec:\n all image tags within the repository will be immutable which will\n prevent them from being overwritten.\n type: string\n- registryID:\n- description: The Amazon Web Services account ID associated with the\n- registry to create the repository. If you do not specify a registry,\n- the default registry is assumed.\n- type: string\n- repositoryName:\n+ name:\n description: The name to use for the repository. The repository name\n may be specified on its own (such as nginx-web-app) or it can be\n prepended with a namespace to group the repository into a category\n (such as project-a/nginx-web-app).\n type: string\n+ registryID:\n+ description: The Amazon Web Services account ID associated with the\n+ registry to create the repository. If you do not specify a registry,\n+ the default registry is assumed.\n+ type: string\n tags:\n description: The metadata that you apply to the repository to help\n you categorize and organize them. Each tag consists of a key and\n@@ -92,7 +92,7 @@ spec:\n type: object\n type: array\n required:\n- - repositoryName\n+ - name\n type: object\n status:\n description: RepositoryStatus defines the observed state of Repository\ndiff --git a/generator.yaml b/generator.yaml\nindex cb7045a..ed0130f 100644\n--- a/generator.yaml\n+++ b/generator.yaml\n@@ -2,3 +2,16 @@ ignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\n+resources:\n+ Repository:\n+ renames:\n+ operations:\n+ CreateRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DeleteRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DescribeRepositories:\n+ input_fields:\n+ RepositoryName: Name\ndiff --git a/helm/crds/ecr.services.k8s.aws_repositories.yaml b/helm/crds/ecr.services.k8s.aws_repositories.yaml\nindex 438785e..9657569 100644\n--- a/helm/crds/ecr.services.k8s.aws_repositories.yaml\n+++ b/helm/crds/ecr.services.k8s.aws_repositories.yaml\n@@ -61,17 +61,17 @@ spec:\n all image tags within the repository will be immutable which will\n prevent them from being overwritten.\n type: string\n- registryID:\n- description: The Amazon Web Services account ID associated with the\n- registry to create the repository. If you do not specify a registry,\n- the default registry is assumed.\n- type: string\n- repositoryName:\n+ name:\n description: The name to use for the repository. The repository name\n may be specified on its own (such as nginx-web-app) or it can be\n prepended with a namespace to group the repository into a category\n (such as project-a/nginx-web-app).\n type: string\n+ registryID:\n+ description: The Amazon Web Services account ID associated with the\n+ registry to create the repository. If you do not specify a registry,\n+ the default registry is assumed.\n+ type: string\n tags:\n description: The metadata that you apply to the repository to help\n you categorize and organize them. Each tag consists of a key and\n@@ -92,7 +92,7 @@ spec:\n type: object\n type: array\n required:\n- - repositoryName\n+ - name\n type: object\n status:\n description: RepositoryStatus defines the observed state of Repository\ndiff --git a/pkg/resource/repository/delta.go b/pkg/resource/repository/delta.go\nindex a15d260..57b54df 100644\n--- a/pkg/resource/repository/delta.go\n+++ b/pkg/resource/repository/delta.go\n@@ -77,6 +77,13 @@ func newResourceDelta(\n delta.Add(\u0026quot;Spec.ImageTagMutability\u0026quot;, a.ko.Spec.ImageTagMutability, b.ko.Spec.ImageTagMutability)\n }\n }\n+ if ackcompare.HasNilDifference(a.ko.Spec.Name, b.ko.Spec.Name) {\n+ delta.Add(\u0026quot;Spec.Name\u0026quot;, a.ko.Spec.Name, b.ko.Spec.Name)\n+ } else if a.ko.Spec.Name != nil \u0026amp;\u0026amp; b.ko.Spec.Name != nil {\n+ if *a.ko.Spec.Name != *b.ko.Spec.Name {\n+ delta.Add(\u0026quot;Spec.Name\u0026quot;, a.ko.Spec.Name, b.ko.Spec.Name)\n+ }\n+ }\n if ackcompare.HasNilDifference(a.ko.Spec.RegistryID, b.ko.Spec.RegistryID) {\n delta.Add(\u0026quot;Spec.RegistryID\u0026quot;, a.ko.Spec.RegistryID, b.ko.Spec.RegistryID)\n } else if a.ko.Spec.RegistryID != nil \u0026amp;\u0026amp; b.ko.Spec.RegistryID != nil {\n@@ -84,13 +91,6 @@ func newResourceDelta(\n delta.Add(\u0026quot;Spec.RegistryID\u0026quot;, a.ko.Spec.RegistryID, b.ko.Spec.RegistryID)\n }\n }\n- if ackcompare.HasNilDifference(a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName) {\n- delta.Add(\u0026quot;Spec.RepositoryName\u0026quot;, a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName)\n- } else if a.ko.Spec.RepositoryName != nil \u0026amp;\u0026amp; b.ko.Spec.RepositoryName != nil {\n- if *a.ko.Spec.RepositoryName != *b.ko.Spec.RepositoryName {\n- delta.Add(\u0026quot;Spec.RepositoryName\u0026quot;, a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName)\n- }\n- }\n if !reflect.DeepEqual(a.ko.Spec.Tags, b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n }\ndiff --git a/pkg/resource/repository/resource.go b/pkg/resource/repository/resource.go\nindex e15d755..a2dd27e 100644\n--- a/pkg/resource/repository/resource.go\n+++ b/pkg/resource/repository/resource.go\n@@ -88,7 +88,7 @@ func (r *resource) SetIdentifiers(identifier *ackv1alpha1.AWSIdentifiers) error\n if identifier.NameOrID == \u0026quot;\u0026quot; {\n return ackerrors.MissingNameIdentifier\n }\n- r.ko.Spec.RepositoryName = \u0026amp;identifier.NameOrID\n+ r.ko.Spec.Name = \u0026amp;identifier.NameOrID\n \n f2, f2ok := identifier.AdditionalKeys[\u0026quot;registryID\u0026quot;]\n if f2ok {\ndiff --git a/pkg/resource/repository/sdk.go b/pkg/resource/repository/sdk.go\nindex 4366244..61a0053 100644\n--- a/pkg/resource/repository/sdk.go\n+++ b/pkg/resource/repository/sdk.go\n@@ -132,9 +132,9 @@ func (rm *resourceManager) sdkFind(\n ko.Status.ACKResourceMetadata.ARN = \u0026amp;tmpARN\n }\n if elem.RepositoryName != nil {\n- ko.Spec.RepositoryName = elem.RepositoryName\n+ ko.Spec.Name = elem.RepositoryName\n } else {\n- ko.Spec.RepositoryName = nil\n+ ko.Spec.Name = nil\n }\n if elem.RepositoryUri != nil {\n ko.Status.RepositoryURI = elem.RepositoryUri\n@@ -158,7 +158,7 @@ func (rm *resourceManager) sdkFind(\n func (rm *resourceManager) requiredFieldsMissingFromReadManyInput(\n r *resource,\n ) bool {\n- return r.ko.Spec.RepositoryName == nil\n+ return r.ko.Spec.Name == nil\n \n }\n \n@@ -172,9 +172,9 @@ func (rm *resourceManager) newListRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n+ if r.ko.Spec.Name != nil {\n f3 := []*string{}\n- f3 = append(f3, r.ko.Spec.RepositoryName)\n+ f3 = append(f3, r.ko.Spec.Name)\n res.SetRepositoryNames(f3)\n }\n \n@@ -253,9 +253,9 @@ func (rm *resourceManager) sdkCreate(\n ko.Status.ACKResourceMetadata.ARN = \u0026amp;arn\n }\n if resp.Repository.RepositoryName != nil {\n- ko.Spec.RepositoryName = resp.Repository.RepositoryName\n+ ko.Spec.Name = resp.Repository.RepositoryName\n } else {\n- ko.Spec.RepositoryName = nil\n+ ko.Spec.Name = nil\n }\n if resp.Repository.RepositoryUri != nil {\n ko.Status.RepositoryURI = resp.Repository.RepositoryUri\n@@ -298,8 +298,8 @@ func (rm *resourceManager) newCreateRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n- res.SetRepositoryName(*r.ko.Spec.RepositoryName)\n+ if r.ko.Spec.Name != nil {\n+ res.SetRepositoryName(*r.ko.Spec.Name)\n }\n if r.ko.Spec.Tags != nil {\n f5 := []*svcsdk.Tag{}\n@@ -362,8 +362,8 @@ func (rm *resourceManager) newDeleteRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n- res.SetRepositoryName(*r.ko.Spec.RepositoryName)\n+ if r.ko.Spec.Name != nil {\n+ res.SetRepositoryName(*r.ko.Spec.Name)\n }\n \n return res, nil\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou will note that there were changes made to the \u003ccode\u003erepository.go\u003c/code\u003e file, the \u003ccode\u003epkg/resource/repository/sdk.go\u003c/code\u003e.\u003c/p\u003e\n\u003ch3 id="renaming-things-with-different-names-in-input-and-output-shapes"\u003eRenaming things with different names in input and output shapes\u003c/h3\u003e\n\u003cp\u003eThe second reason we might need to rename a field is when the same field goes by different names in the \u003cem\u003eshapes\u003c/em\u003e (i.e., expected syntax) of the input and output. An hypothetical example of this might be a field that is called \u003ccode\u003eEnableEncryption\u003c/code\u003e in an input shape and \u003ccode\u003eEncryptionEnabled\u003c/code\u003e in an output shape. In order to inform the code generator that these fields are actually the same, we would rename one of the fields to match the other.\u003c/p\u003e\n\u003cp\u003e[\u003cstrong\u003e\u003cem\u003eTODO\u003c/em\u003e\u003c/strong\u003e this needs a concrete example of renaming with both \u003ccode\u003einput_fields\u003c/code\u003e and \u003ccode\u003eoutput_fields\u003c/code\u003e]\u003c/p\u003e\n\u003ch2 id="ignore-ignoring-things"\u003e\u003ccode\u003eignore\u003c/code\u003e: Ignoring things\u003c/h2\u003e\n\u003cp\u003eSometimes you want to instruct the code generator to simply ignore a particular API Operation, or a particular field in an API Shape. See \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/pull/89"\u003ehere\u003c/a\u003e for a real world motivating example of such a need.\u003c/p\u003e\n\u003cp\u003eYou will use the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/f6dd767f12429832bc7b4321fb7b763a9fa997c7/pkg/config/config.go#L50-L66"\u003e\u003ccode\u003eignore:\u003c/code\u003e\u003c/a\u003e block of configuration options to do this.\u003c/p\u003e\n\u003cp\u003eTo ignore a specific field in an API Shape, you can list the field via fieldpath in the \u003ccode\u003eignore.fieldpaths\u003c/code\u003e configuration option.\u003c/p\u003e\n\u003cp\u003eAn \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/blob/9adb7703fa9e8c422a583ec1c8da35ecb21c8917/generator.yaml#L8-L12"\u003eexample\u003c/a\u003e of this can be found in the S3 controller\u0026rsquo;s \u003ccode\u003egenerator.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n field_paths:\n # We cannot support MFA, so if it is set we cannot unset\n - \u0026quot;VersioningConfiguration.MFADelete\u0026quot;\n # This subfield struct has no members...\n - \u0026quot;NotificationConfiguration.EventBridgeConfiguration\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen you specify a field path in \u003ccode\u003eignore.field_paths\u003c/code\u003e, the code generator will skip over that field when inferring custom resource definition \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e structures.\u003c/p\u003e\n\u003ch2 id="tags"\u003eTags\u003c/h2\u003e\n\u003cp\u003e\u003cem\u003eMost\u003c/em\u003e resources in AWS service APIs can have one or more tags associated with them. Tags are \u003cem\u003etypically\u003c/em\u003e simple string key/value pairs; however, the representation of tags across different AWS service APIs is not consistent. Some APIs use a \u003ccode\u003emap[string]string\u003c/code\u003e to represent tags. Others use a \u003ccode\u003e[]struct{}\u003c/code\u003e where the struct has a \u003ccode\u003eKey\u003c/code\u003e and a \u003ccode\u003eValue\u003c/code\u003e field. Others use more complex structures.\u003c/p\u003e\n\u003ch3 id="tagsignore-telling-ack-code-generator-that-a-resource-does-not-support-tags"\u003e\u003ccode\u003etags.ignore\u003c/code\u003e: Telling ACK code generator that a resource does not support tags\u003c/h3\u003e\n\u003cp\u003eThere are some API resources that \u003cem\u003edo not\u003c/em\u003e support tags at all, and we want a way to skip the generation of code that handles tagging for those resources. By default, for all resources, ACK generates some code that handles conversion between the ACK standard representation of tags (i.e., \u003ccode\u003emap[string]string\u003c/code\u003e) and the AWS service-specific representation of tags (e.g., \u003ccode\u003e[]struct{}\u003c/code\u003e, etc).\u003c/p\u003e\n\u003cp\u003eIf you attempt to generate a resource manager for a resource that does not support tags, you will receive an error from the code generator. ECR\u0026rsquo;s \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreatePullThroughCacheRule.html"\u003e\u003ccode\u003ePassThroughCacheRule\u003c/code\u003e\u003c/a\u003e is an example of a resource that does not support tags. If we unignore the \u003ccode\u003ePassThroughCacheRule\u003c/code\u003e resource in the ECR controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L78"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file and regenerate the controller, we will stumble upon this error:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio code-generator]$ make build-controller SERVICE=ecr\nbuilding ack-generate ... ok.\n==== building ecr-controller ====\nCopying common custom resource definitions into ecr\nBuilding Kubernetes API objects for ecr\nGenerating deepcopy code for ecr\nGenerating custom resource definitions for ecr\nBuilding service controller for ecr\nError: template: /home/jaypipes/go/src/github.com/aws-controllers-k8s/code-generator/templates/pkg/resource/manager.go.tpl:282:20: executing \u0026quot;/home/jaypipes/go/src/github.com/aws-controllers-k8s/code-generator/templates/pkg/resource/manager.go.tpl\u0026quot; at \u0026lt;.CRD.GetTagField\u0026gt;: error calling GetTagField: tag field path Tags does not exist inside PullThroughCacheRule crd\nmake: *** [Makefile:41: build-controller] Error 1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo fix this error, we used the \u003ccode\u003etags.ignore\u003c/code\u003e configuration option in \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L78"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n #- Repository\n #- PullThroughCacheRule\nresources:\n Repository:\n renames:\n operations:\n CreateRepository:\n input_fields:\n RepositoryName: Name\n DeleteRepository:\n input_fields:\n RepositoryName: Name\n DescribeRepositories:\n input_fields:\n RepositoryName: Name\n PullThroughCacheRule:\n fields:\n ECRRepositoryPrefix:\n is_primary_key: true\n \u0026gt; tags:\n \u0026gt; ignore: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="resource-configuration"\u003eResource configuration\u003c/h2\u003e\n\u003ch3 id="understanding-resource-identifying-fields"\u003eUnderstanding resource-identifying fields\u003c/h3\u003e\n\u003cp\u003eAll resources in the AWS world have one or more fields that serve as primary key identifiers. Most people are familiar with the \u003ccode\u003eARN\u003c/code\u003e fields that most modern AWS resources have. However, the \u003ccode\u003eARN\u003c/code\u003e field is not the only field that can serve as a primary key for a resource. ACK\u0026rsquo;s code generator reads an API model file and attempts to determine which fields on a resource can be used to uniquely identify that resource. Sometimes, though, the code generator needs to be instructed which field or fields comprise this primary key. \u003ca href="#Field-level-configuration-of-identifying-fields"\u003eSee below\u003c/a\u003e for an example from ECR\u0026rsquo;s \u003ccode\u003ePullThroughCacheRule\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThere are resource-level and field-level configuration options that inform the code generator about identifying fields.\u003c/p\u003e\n\u003ch4 id="is_arn_primary_key-resource-level-configuration-of-identifying-fields"\u003e\u003ccode\u003eis_arn_primary_key\u003c/code\u003e: Resource-level configuration of identifying fields\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003eresources[$resource].is_arn_primary_key\u003c/code\u003e configuration option is a boolean, defaulting to \u003ccode\u003efalse\u003c/code\u003e that instructs the code generator to use the \u003ccode\u003eARN\u003c/code\u003e field when calling the \u0026ldquo;ReadOne\u0026rdquo; (i.e., \u0026ldquo;Describe\u0026rdquo; or \u0026ldquo;Get\u0026rdquo;) operation for that resource. When \u003ccode\u003efalse\u003c/code\u003e, the code generator will look for \u0026ldquo;identifier fields\u0026rdquo; with field names such as \u003ccode\u003eID\u003c/code\u003e or \u003ccode\u003eName\u003c/code\u003e (along with variants that include the resource name as a prefix, e.g., \u0026ldquo;BucketName\u0026rdquo;).\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eis_arn_primary_key=true\u003c/code\u003e configuration option \u003cem\u003ewhen the resource has no other identifying fields\u003c/em\u003e. An example of this is SageMaker\u0026rsquo;s \u003ccode\u003eModelPackage\u003c/code\u003e resource that has no \u003ccode\u003eName\u003c/code\u003e or \u003ccode\u003eID\u003c/code\u003e field and can only be identified via an \u003ccode\u003eARN\u003c/code\u003e field:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n ModelPackage:\n is_arn_primary_key: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003e[NOTE(jaypipes): Probably want to reevaluate this particular config option and use the field-centric is_primary_key option instead\u0026hellip;]\u003c/em\u003e\u003c/p\u003e\n\u003ch4 id="is_primary_key-field-level-configuration-of-identifying-fields"\u003e\u003ccode\u003eis_primary_key\u003c/code\u003e: Field-level configuration of identifying fields\u003c/h4\u003e\n\u003cp\u003eSometimes a resource\u0026rsquo;s primary key field is non-obvious (like \u003ccode\u003eName\u003c/code\u003e or \u003ccode\u003eID\u003c/code\u003e). Use the \u003ccode\u003eresources[$resource]fields[$field].is_primary_key\u003c/code\u003e configuration option to tell the code generator about these fields.\u003c/p\u003e\n\u003cp\u003eAn example here is ECR\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L57"\u003e\u003ccode\u003ePullThroughCacheRule\u003c/code\u003e\u003c/a\u003e resource, which \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreatePullThroughCacheRule.html"\u003ehas a primary key field\u003c/a\u003e called \u003ccode\u003eECRRepositoryPrefix\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n PullThroughCacheRule:\n fields:\n ECRRepositoryPrefix:\n is_primary_key: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003e[NOTE(jljaco): If we discard \u003ccode\u003eis_arn_primary_key\u003c/code\u003e in favor of only \u003ccode\u003eis_primary_key\u003c/code\u003e, this sub-section should be moved into the \u003ccode\u003eField Configuration\u003c/code\u003e section]\u003c/em\u003e\u003c/p\u003e\n\u003ch3 id="exceptions-correcting-exception-codes"\u003e\u003ccode\u003eexceptions\u003c/code\u003e: Correcting exception codes\u003c/h3\u003e\n\u003cp\u003eAn ACK controller needs to understand which HTTP exception code means \u0026ldquo;this resource was not found\u0026rdquo;; otherwise, the controller\u0026rsquo;s logic that determines whether to create or update a resource falls apart.\u003c/p\u003e\n\u003cp\u003eFor the majority of AWS service APIs, the ACK code generator can figure out which HTTP exception codes map to which HTTP fault behaviours. However, some AWS service API model definitions do not include exception metadata. Other service API models include straight-up incorrect information that does not match what the actual AWS service returns.\u003c/p\u003e\n\u003cp\u003eTo address these issues, you can use the \u003ccode\u003eresources[$resource].exceptions\u003c/code\u003e configuration block.\u003c/p\u003e\n\u003cp\u003eAn example of an API model that does not indicate the exception code representing a resource not found is DynamoDB. When calling DynamoDB\u0026rsquo;s \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html"\u003e\u003ccode\u003eDescribeTable\u003c/code\u003e\u003c/a\u003e API call with a table name that does not exist, you will get back a \u003ccode\u003e400\u003c/code\u003e error code instead of \u003ccode\u003e404\u003c/code\u003e and the exception code string is \u003ccode\u003eResourceNotFoundException\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eTo tell the ACK code generator how to deal with this, use the \u003ccode\u003eexceptions\u003c/code\u003e \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/160b839fe09dd7e1f321e094604ffc3b6ae2a285/pkg/config/resource.go#L251"\u003econfiguration option\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Table:\n exceptions:\n errors:\n 404:\n code: ResourceNotFoundException\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis configuration instructs the code generator to \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/eb1405d3d10050c8a866dc0e2dc0ec72c8213886/pkg/resource/table/sdk.go#L79-L84"\u003eproduce code\u003c/a\u003e that looks for \u003ccode\u003eResourceNotFoundException\u003c/code\u003e in the error response of the API call and interprets it properly as a \u003ccode\u003e404\u003c/code\u003e or \u0026ldquo;resource not found\u0026rdquo; error.\u003c/p\u003e\n\u003ch4 id="terminal_codes-specifying-terminal-codes-to-indicate-terminal-state"\u003e\u003ccode\u003eterminal_codes\u003c/code\u003e: Specifying terminal codes to indicate terminal state\u003c/h4\u003e\n\u003cp\u003eAn \u003ccode\u003eACK.Terminal\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e is placed on a custom resource (inside of its \u003ccode\u003eStatus\u003c/code\u003e) when the controller realizes that, without the user changing the resource\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e, the resource will not be able to be reconciled (i.e., the desired state will never match the actual state).\u003c/p\u003e\n\u003cp\u003eWhen an ACK controller gets a response back from an AWS service containing an error code, the controller evaluates whether that error code should result in the \u003ccode\u003eACK.Terminal\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e being placed on the resource. Examples of these \u0026ldquo;terminal codes\u0026rdquo; are things such as:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eimproper input being supplied\u003c/li\u003e\n\u003cli\u003ea duplicate resource already existing\u003c/li\u003e\n\u003cli\u003econflicting input values\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eAWS service API responses having a \u003ccode\u003e4XX\u003c/code\u003e HTTP status code will have a corresponding exception string code (e.g., \u003ccode\u003eInvalidParameterValue\u003c/code\u003e or \u003ccode\u003eEntityExistsException\u003c/code\u003e). Use the \u003ccode\u003eresources[$resource].exceptions.terminal_codes\u003c/code\u003e configuration option to tell the code generation which of these exception string codes it should consider to be a \u003cem\u003eterminal state\u003c/em\u003e for the resource.\u003c/p\u003e\n\u003cp\u003eHere is \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L97"\u003ean example from the RDS controller\u003c/a\u003e, where we indicate the set of exception string code that will set the resource into a \u003cem\u003eterminal state\u003c/em\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBCluster:\n exceptions:\n terminal_codes:\n - DBClusterQuotaExceededFault\n - DBSubnetGroupDoesNotCoverEnoughAZs\n - InsufficientStorageClusterCapacity\n - InvalidParameter\n - InvalidParameterValue\n - InvalidParameterCombination\n - InvalidSubnet\n - StorageQuotaExceeded\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="reconcile-controlling-reconciliation-and-requeue-logic"\u003e\u003ccode\u003ereconcile\u003c/code\u003e: Controlling reconciliation and requeue logic\u003c/h3\u003e\n\u003cp\u003eBy default, an ACK controller will requeue a resource for future reconciliation only when the resource is in some transitional state.\u003c/p\u003e\n\u003cp\u003eFor example, when you create an RDS \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L184"\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/a\u003e resource, the resource initially goes into a \u003ccode\u003eCREATING\u003c/code\u003e transitional state and then eventually will arrive at an \u003ccode\u003eAVAILABLE\u003c/code\u003e state. When the RDS controller for ACK initially creates the RDS \u003ccode\u003eDBInstance\u003c/code\u003e resource, it calls the RDS \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html"\u003e\u003ccode\u003eCreateDBInstance\u003c/code\u003e\u003c/a\u003e API call, sees the state of the DB instance is \u003ccode\u003eCREATING\u003c/code\u003e, adds an \u003ccode\u003eACK.ResourceSynced=False\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e to the resource and \u003cem\u003erequeues\u003c/em\u003e the resource to be processed again in a few seconds.\u003c/p\u003e\n\u003cp\u003eWhen the resource is processed in the next reconciliation loop, the controller calls the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html"\u003e\u003ccode\u003eDescribeDBInstance\u003c/code\u003e\u003c/a\u003e API endpoint and checks to see if the DB instance is in the \u003ccode\u003eAVAILABLE\u003c/code\u003e state. If it is not, then the controller requeues the resource again. If it is in the \u003ccode\u003eAVAILABLE\u003c/code\u003e state, then the controller sets the \u003ccode\u003eACK.ResourceSynced\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e to \u003ccode\u003eTrue\u003c/code\u003e, which is the indication to the ACK runtime that the resource should \u003cem\u003enot\u003c/em\u003e be requeued.\u003c/p\u003e\n\u003cp\u003eSometimes, you may want to have the ACK controller requeue certain resources \u003cem\u003eeven after a successful reconciliation loop that leaves the resource in the \u003ccode\u003eACK.ResourceSynced=True\u003c/code\u003e state\u003c/em\u003e. If this is the case, you should use the \u003ccode\u003eresources[$resource].reconcile.requeue_on_success_seconds\u003c/code\u003e configuration option. The value of this option should be the amount of time (in seconds) after which the reconciler should requeue the resource.\u003c/p\u003e\n\u003cp\u003eHere is an example of this configuration option as used in the SageMaker controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/blob/c77c6def970cf80322bacaa6aa5ff58dde671dbf/generator.yaml#L595"\u003e\u003ccode\u003eNotebookInstance\u003c/code\u003e resource\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n NotebookInstance:\n # Resource state/status can be modified in Sagemaker Console\n # Need to reconcile to catch these state/status changes\n reconcile: \n requeue_on_success_seconds: 60\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe set this \u003ccode\u003erequeue_on_success_seconds\u003c/code\u003e value to \u003ccode\u003e60\u003c/code\u003e here because the values of various fields in this Sagemaker resource tend to change often and we want the \u003ccode\u003eStatus\u003c/code\u003e section of our custom resource to contain values that are fresher than the default requeue period (10 hours as of this writing).\u003c/p\u003e\n\u003ch3 id="including-additional-printer-columns"\u003eIncluding additional printer columns\u003c/h3\u003e\n\u003cp\u003e\u003cstrong\u003eTODO(jljaco)\u003c/strong\u003e\u003c/p\u003e\n\u003ch2 id="field-configuration"\u003eField configuration\u003c/h2\u003e\n\u003cp\u003eWhen \u003ccode\u003eack-generate\u003c/code\u003e first \u003ca href="https://aws-controllers-k8s.github.io/community/docs/contributor-docs/api-inference/"\u003einfers the definition of a resource\u003c/a\u003e from the AWS API model, it collects the various member fields of a resource. This documentation section discusses the configuration options that instruct the code generator about a particular resource field.\u003c/p\u003e\n\u003ch3 id="is_read_only-manually-marking-a-field-as-belonging-to-the-resource-status-struct"\u003e\u003ccode\u003eis_read_only\u003c/code\u003e: Manually marking a field as belonging to the resource \u003ccode\u003eStatus\u003c/code\u003e struct\u003c/h3\u003e\n\u003cp\u003eDuring API inference, \u003ccode\u003eack-generate\u003c/code\u003e automatically determines which fields belong in the custom resource definition\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e struct. Fields that can be modified by the user go in the \u003ccode\u003eSpec\u003c/code\u003e and fields that cannot be modified go in the \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].is_read_only\u003c/code\u003e configuration option to override whether a field should go in the \u003ccode\u003eStatus\u003c/code\u003e struct.\u003c/p\u003e\n\u003cp\u003eHere is an example from the Lambda controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/blob/2ee7a2969ee23c900a18f6265a272669b058b62e/generator.yaml#L52-L53"\u003egenerator.yaml\u003c/a\u003e file that instructs the code generator to treat the \u003ccode\u003eLayerStatuses\u003c/code\u003e field as a read-only field (and thus should belong in the \u003ccode\u003eStatus\u003c/code\u003e struct for the Function resource):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Function:\n fields:\n LayerStatuses:\n is_read_only: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTypically, you will see this configuration option used for fields that have two different Go types representing the modifiable version of the field and the non-modifiable version of the field (as is the case for a Lambda Function\u0026rsquo;s Layers information) or when you need to create a custom field.\u003c/p\u003e\n\u003ch3 id="is_required-marking-a-field-as-required"\u003e\u003ccode\u003eis_required\u003c/code\u003e: Marking a field as required\u003c/h3\u003e\n\u003cp\u003eIf an AWS API model file marks a particular member field as required, \u003ccode\u003eack-generate\u003c/code\u003e will usually infer that the associated custom resource field is required. Sometimes, however, you may want to override whether or not a field should be required. Use the \u003ccode\u003eresources[$resource].fields[$field].is_required\u003c/code\u003e configuration option to do so.\u003c/p\u003e\n\u003cp\u003eHere is an example from the EC2 controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/3b1ba705df02f9b7db1a8079ed7729af7a4f213a/generator.yaml#L206-L209"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file that instructs the code generator to treat the Instance custom resource\u0026rsquo;s MinCount and MaxCount fields as \u003cstrong\u003enot required\u003c/strong\u003e, even though the API model definition marks these fields as required in the Create Operation\u0026rsquo;s Input shape.\u003c/p\u003e\n\u003cp\u003eNOTE: The reason for this is because the EC2 controller only deals with single Instance resources, not batches of instances\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Instance:\n fields:\n MaxCount:\n is_required: false\n MinCount:\n is_required: false\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="type-controlling-a-fields-go-type"\u003e\u003ccode\u003etype\u003c/code\u003e: controlling a field\u0026rsquo;s Go type\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].type\u003c/code\u003e configuration option to override a field\u0026rsquo;s Go type. You will typically use this configuration option for custom fields that are not inferred by \u003ccode\u003eack-generate\u003c/code\u003e by looking at the AWS API model definition.\u003c/p\u003e\n\u003cp\u003eAn example of this is the Policies field for a Role custom resource definition in the IAM controller. The IAM controller uses some custom hook code to allow a Kubernetes user to specify one or more Policy ARNs for a Role simply by specifying \u003ccode\u003eSpec.Policies\u003c/code\u003e. To define this custom field as a list of string pointers, the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/generator.yaml#L164-L168"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file uses the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Role:\n fields:\n # In order to support attaching zero or more policies to a Role, we use\n # custom update code path code that uses the Attach/DetachGroupPolicy API\n # calls to manage the set of PolicyARNs attached to this Role.\n Policies:\n type: \u0026quot;[]*string\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="compare-controlling-how-a-fields-values-are-compared"\u003e\u003ccode\u003ecompare\u003c/code\u003e: Controlling how a field\u0026rsquo;s values are compared\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].compare\u003c/code\u003e configuration option to control how the value of a field is compared between two resources. This configuration option has two boolean subfields, \u003ccode\u003eis_ignored\u003c/code\u003e and \u003ccode\u003enil_equals_zero_value\u003c/code\u003e (TODO(jljaco): \u003ccode\u003enil_equals_zero_value\u003c/code\u003e not yet implemented or used).\u003c/p\u003e\n\u003ch4 id="is_ignored-marking-a-field-as-ignored"\u003e\u003ccode\u003eis_ignored\u003c/code\u003e: marking a field as ignored\u003c/h4\u003e\n\u003cp\u003eUse the \u003ccode\u003eis_ignored\u003c/code\u003e subfield to instruct the code generator to exclude this particular field from automatic value comparisons when building the \u003ccode\u003eDelta\u003c/code\u003e struct that compares two resources.\u003c/p\u003e\n\u003cp\u003eTypically, you will want to mark a field as ignored for comparison operations because the Go type of the field does not natively support deterministic equality operations. For example, a slice of \u003ccode\u003eTag\u003c/code\u003e structs where the code generator does not know how to sort the slice means that the default \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e call will produce non-deterministic results. These types of fields you will want to mark with \u003ccode\u003ecompare.is_ignored: true\u003c/code\u003e and include a custom comparison function using the \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook, \u003ca name="#delta_pre_compare_example_1"\u003e\u003c/a\u003eas this example from the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/generator.yaml#L172-L174"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e does for the Role resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e Role:\n hooks:\n delta_pre_compare:\n code: compareTags(delta, a, b)\n fields:\n Tags:\n compare:\n is_ignored: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="is_immutable-mutable-vs-immutable-fields"\u003e\u003ccode\u003eis_immutable\u003c/code\u003e: Mutable vs. immutable fields\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].is_immutable\u003c/code\u003e configuration option to mark a field as immutable \u0026ndash; meaning the user cannot update the field after initially setting its value.\u003c/p\u003e\n\u003cp\u003eA good example of the use of \u003ccode\u003eis_immutable\u003c/code\u003e comes from the RDS controller\u0026rsquo;s DBInstance resource\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/generator.yaml#L209-L212"\u003eAvailabilityZone field\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n fields:\n AvailabilityZone:\n late_initialize: {}\n is_immutable: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the case of a DBInstance resource, once the AvailabilityZone field is set by the user, it cannot be modified.\u003c/p\u003e\n\u003cp\u003eBy telling the code generator that this field is immutable, it will generate code in the \u003ccode\u003esdk.go\u003c/code\u003e file that \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/pkg/resource/db_instance/sdk.go#L2768"\u003echecks for whether a user has modified any immutable fields\u003c/a\u003e and set a Condition on the resource if so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// sdkUpdate patches the supplied resource in the backend AWS service API and\n// returns a new resource with updated fields.\nfunc (rm *resourceManager) sdkUpdate(\n ctx context.Context,\n desired *resource,\n latest *resource,\n delta *ackcompare.Delta,\n) (updated *resource, err error) {\n rlog := ackrtlog.FromContext(ctx)\n exit := rlog.Trace(\u0026quot;rm.sdkUpdate\u0026quot;)\n defer func() {\n exit(err)\n }()\n if immutableFieldChanges := rm.getImmutableFieldChanges(delta); len(immutableFieldChanges) \u0026gt; 0 {\n msg := fmt.Sprintf(\u0026quot;Immutable Spec fields have been modified: %s\u0026quot;, strings.Join(immutableFieldChanges, \u0026quot;,\u0026quot;))\n return nil, ackerr.NewTerminalError(fmt.Errorf(msg))\n }\n ...\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="from-controlling-the-source-of-a-fields-definition"\u003e\u003ccode\u003efrom\u003c/code\u003e: Controlling the source of a field\u0026rsquo;s definition\u003c/h3\u003e\n\u003cp\u003eDuring API inference, \u003ccode\u003eack-generate\u003c/code\u003e inspects the AWS service API model definition and discovers resource fields by looking at the Input and Output shapes of the \u003ccode\u003eCreate\u003c/code\u003e API call for that resource. Members of the Input shape will go in the \u003ccode\u003eSpec\u003c/code\u003e and members of the Output shape \u003cem\u003ethat are not also in the Input shape\u003c/em\u003e will go into the \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThis works for a majority of the field definitions, however sometimes you want to \u0026ldquo;grab a field\u0026rdquo; from a different location (i.e., other than either the Input or Output shapes of the \u003ccode\u003eCreate\u003c/code\u003e API call).\u003c/p\u003e\n\u003cp\u003eEach Resource typically also has a \u003ccode\u003eReadOne\u003c/code\u003e Operation. The ACK service controller will call this \u003ccode\u003eReadOne\u003c/code\u003e Operation to get the latest observed state of a particular resource in the backend AWS API service. The service controller sets the observed Resource\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e fields from the Output shape of the \u003ccode\u003eReadOne\u003c/code\u003e Operation. The code generator is responsible for producing the Go code that performs these \u0026ldquo;setter\u0026rdquo; methods on the Resource.\u003c/p\u003e\n\u003cp\u003eThe way the code generator determines how to set the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e fields from the Output shape\u0026rsquo;s member fields is by looking at the data type of the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e field with the same name as the Output shape\u0026rsquo;s member field.\u003c/p\u003e\n\u003cp\u003eImportantly, in producing this \u0026ldquo;setter\u0026rdquo; Go code the code generator \u003cstrong\u003eassumes that the data types (Go types) in the source (the Output shape\u0026rsquo;s member field) and target (the Spec or Status field) are the same\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eThere are some APIs, however, where the Go type of the field in the \u003ccode\u003eCreate\u003c/code\u003e Operation\u0026rsquo;s Input shape is actually different from the same-named field in the \u003ccode\u003eReadOne\u003c/code\u003e Operation\u0026rsquo;s Output shape. A good example of this is the Lambda \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html"\u003e\u003ccode\u003eCreateFunction\u003c/code\u003e\u003c/a\u003e API call, which has a \u003ccode\u003eCode\u003c/code\u003e member of its Input shape that looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e\u0026quot;Code\u0026quot;: {\n \u0026quot;ImageUri\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3Bucket\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3Key\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3ObjectVersion\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;ZipFile\u0026quot;: blob\n},\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunction.html"\u003e\u003ccode\u003eGetFunction\u003c/code\u003e\u003c/a\u003e API call\u0026rsquo;s Output shape has a same-named field called \u003ccode\u003eCode\u003c/code\u003e in it, but this field looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e\u0026quot;Code\u0026quot;: {\n \u0026quot;ImageUri\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;Location\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;RepositoryType\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;ResolvedImageUri\u0026quot;: \u0026quot;string\u0026quot;\n},\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis presents a conundrum to the ACK code generator, which, as noted above, assumes the data types of same-named fields in the \u003ccode\u003eCreate\u003c/code\u003e Operation\u0026rsquo;s Input shape and \u003ccode\u003eReadOne\u003c/code\u003e Operation\u0026rsquo;s Output shape are the same.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].from\u003c/code\u003e configuration option to handle these situations.\u003c/p\u003e\n\u003cp\u003eFor the Lambda \u003ccode\u003eFunction\u003c/code\u003e Resource\u0026rsquo;s \u003ccode\u003eCode\u003c/code\u003e field, we can inform the code generator to create three new \u003ccode\u003eStatus\u003c/code\u003e fields (read-only) from the \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eRepositoryType\u003c/code\u003e and \u003ccode\u003eResolvedImageUri\u003c/code\u003e fields in the \u003ccode\u003eCode\u003c/code\u003e member of the \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunction.html"\u003e\u003ccode\u003eReadOne\u003c/code\u003e\u003c/a\u003e Operation\u0026rsquo;s Output shape:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Function:\n fields:\n CodeLocation:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.Location\n CodeRepositoryType:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.RepositoryType\n CodeRegisteredImageURI:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.RegisteredImageUri\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE on maintainability:\u003c/strong\u003e Another way of solving this particular problem would be to use a completely new custom field. However, \u003cem\u003ewe only use this as a last resort\u003c/em\u003e. The reason why we prefer to use the \u003ccode\u003efrom:\u003c/code\u003e configuration option is because this approach will adapt over time with changes to the AWS service API model, including documentation \u003cem\u003eabout\u003c/em\u003e those fields, whereas completely new custom fields will always need to be hand-rolled and no API documentation will be auto-generated for them.\u003c/p\u003e\n\u003ch3 id="print-controlling-a-fields-output-as-printer-columns-in-kubectl-get"\u003e\u003ccode\u003eprint\u003c/code\u003e: Controlling a field\u0026rsquo;s output as printer columns in \u003ccode\u003ekubectl get\u003c/code\u003e\u003c/h3\u003e\n\u003cp\u003eIf we want to add one of a Resource\u0026rsquo;s fields to the output of the \u003ccode\u003ekubectl get\u003c/code\u003e command, we can do so by annotating that field\u0026rsquo;s configuration with a \u003ccode\u003eprint:\u003c/code\u003e section. An example of this is in the EC2 controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L244"\u003e\u003ccode\u003eElasticIPAddress\u003c/code\u003e Resource\u003c/a\u003e, for which we would like to include the \u003ccode\u003ePublicIP\u003c/code\u003e field in the output of \u003ccode\u003ekubectl get\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n ...\n ElasticIPAddress:\n ...\n fields:\n ...\n\u0026gt; PublicIp:\n\u0026gt; print:\n\u0026gt; name: PUBLIC-IP\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIncluding this in the field\u0026rsquo;s configuration will cause the code generator to produce \u003ccode\u003ekubebuilder\u003c/code\u003e markers in the appropriate place in its generated code, which will result in the field being included in the \u003ccode\u003ekubectl get\u003c/code\u003e output.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e this configuration is used to include printer columns in the output at the level of individual fields. One can also create \u003ca href="#including-additional-printer-columns"\u003eadditional printer columns\u003c/a\u003e at the level of Resources.\u003c/p\u003e\n\u003ch3 id="late_initialize-late-initialization-of-a-field"\u003e\u003ccode\u003elate_initialize\u003c/code\u003e: Late initialization of a field\u003c/h3\u003e\n\u003cp\u003e\u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#controller-assigned-defaults-aka-late-initialization"\u003eLate initialization of a field\u003c/a\u003e is a Kubernetes Resource Model concept that allows for a nil-valued field to be defaulted to some value \u003cem\u003eafter the resource has been successfully created\u003c/em\u003e. This is akin to a database table field\u0026rsquo;s \u0026ldquo;default value\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eLate initialized fields are slightly awkward for an ACK controller to handle, primarily because late initialized fields end up being erroneously identified as having different values in the \u003ca href="#the-comparison-hook-points"\u003eDelta comparisons\u003c/a\u003e. The desired state of the field is \u003ccode\u003enil\u003c/code\u003e but the server-side default value of that field is some non-\u003ccode\u003enil\u003c/code\u003e value.\u003c/p\u003e\n\u003cp\u003eACK\u0026rsquo;s code generator can output Go code that handles this server-side defaulting behaviour (we call this \u0026ldquo;late initialization\u0026rdquo;). To instruct the code generator to generate late initialization code for a field, use the \u003ccode\u003eresources[$resource].fields[$field].late_initialize\u003c/code\u003e configuration option.\u003c/p\u003e\n\u003cp\u003eA good example of late initialization can be found in the RDS controller. For \u003ccode\u003eDBInstance\u003c/code\u003e resources, if the user does not specify an availability zone when creating the \u003ccode\u003eDBInstance\u003c/code\u003e, RDS chooses one for the user. To ensure that the RDS controller understands that the \u003ccode\u003eAvailabilityZone\u003c/code\u003e field is set to a default value after creation, the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L211"\u003efollowing configuration\u003c/a\u003e is set in the \u003ccode\u003egenerator.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n fields:\n AvailabilityZone:\n\u0026gt; late_initialize: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: the \u003ccode\u003elate_initialize:\u003c/code\u003e configuration option is currently a struct with a couple member fields that are not yet implemented (as of Dec 2022), which is why you need to use the \u003ccode\u003e{}\u003c/code\u003e notation.\u003c/p\u003e\n\u003ch3 id="references-making-a-field-refer-to-another-resource"\u003e\u003ccode\u003ereferences\u003c/code\u003e: Making a field refer to another Resource\u003c/h3\u003e\n\u003cp\u003eOne custom resource can refer to another custom resource using something called Resource References. The Go code that handles the validation and resolution of Resource References is generated by \u003ccode\u003eack-generate\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].references\u003c/code\u003e configuration option to inform the code generator what \u003cem\u003ekind\u003c/em\u003e of Resource a field references and which \u003cem\u003efield\u003c/em\u003e within that Resource is the identifier field.\u003c/p\u003e\n\u003cp\u003eHere is an example from the API Gateway v2 controller that shows an \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/f94a6ba88adda9790a25540729c89a84f7645ccb/generator.yaml#L63"\u003eIntegration Resource\u003c/a\u003e referencing an API and a VPCLink Resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Integration:\n fields:\n ApiId:\n references:\n resource: API\n path: Status.APIID\n ConnectionId:\n references:\n resource: VPCLink\n path: Status.VPCLinkID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter regenerating the controller, the Integration resource will have two \u003cem\u003enew\u003c/em\u003e fields, one called \u003ccode\u003eAPIRef\u003c/code\u003e and another called \u003ccode\u003eConnectionRef\u003c/code\u003e. The \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/5e346c359c25cf29be93b3f3bca30c59cc21a9bf/apis/v1alpha1/integration.go#L26-L31"\u003eGo type of these fields\u003c/a\u003e will be a pointer to an \u003ccode\u003eAWSResourceReferenceWrapper\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003etype IntegrationSpec struct {\n APIID *string `json:\u0026quot;apiID,omitempty\u0026quot;`\n APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:\u0026quot;apiRef,omitempty\u0026quot;`\n\n ConnectionID *string `json:\u0026quot;connectionID,omitempty\u0026quot;`\n ConnectionRef *ackv1alpha1.AWSResourceReferenceWrapper `json:\u0026quot;connectionRef,omitempty\u0026quot;`\n ...\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: The generated name of the reference fields will always be the field name, stripped of any \u0026ldquo;Id\u0026rdquo;, \u0026ldquo;Name\u0026rdquo;, or \u0026ldquo;ARN\u0026rdquo; suffix, plus \u0026ldquo;Ref\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eIn the above example, both the API and VPCLink Resources are managed by the API Gateway v2 controller. It is possible to reference Resources that are managed by a \u003cem\u003edifferent\u003c/em\u003e ACK controller by specifying the \u003ccode\u003eresources[$resource].fields[$field].references.service_name\u003c/code\u003e configuration option, as shown in this example from the RDS controller, which has the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/generator.yaml#L111-L115"\u003eDBCluster resource reference the KMS controller\u0026rsquo;s Key resource\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBCluster:\n fields:\n KmsKeyId:\n references:\n resource: Key\n service_name: kms\n path: Status.ACKResourceMetadata.ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="adding-custom-fields"\u003eAdding custom fields\u003c/h3\u003e\n\u003cp\u003e\u003ccode\u003eresources[$resource].fields[$field].type\u003c/code\u003e \u003cem\u003eoverrides\u003c/em\u003e the inferred Go type of a field. This is required for custom fields that are not inferred (either as a \u003ccode\u003eCreate\u003c/code\u003e Input/Output shape or via the \u003ccode\u003eSourceFieldConfig\u003c/code\u003e attribute).\u003c/p\u003e\n\u003cp\u003eAs an example, assume you have a \u003ccode\u003eRole\u003c/code\u003e Resource where you want to add a custom \u003ccode\u003eSpec\u003c/code\u003e field called \u003ccode\u003ePolicies\u003c/code\u003e that is a slice of string pointers.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003egenerator.yaml\u003c/code\u003e file for the IAM controller \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L172"\u003elooks like this\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Role:\n fields:\n Policies:\n type: []*string\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThere is no \u003ccode\u003ePolicies\u003c/code\u003e field in either the \u003ccode\u003eCreateRole\u003c/code\u003e Input or Output shapes, therefore in order to create a new custom field, we simply add a \u003ccode\u003ePolicies\u003c/code\u003e object in the \u003ccode\u003efields\u003c/code\u003e configuration mapping and tell the code generator what Go type this new field will have \u0026ndash; in this case, \u003ccode\u003e[]*string\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE on maintainability\u003c/strong\u003e: Use custom fields as a last resort! When you use custom fields, you will not get the benefit of auto-generated documentation for your field like you will with auto-inferred or \u003ccode\u003efrom:\u003c/code\u003e-configured fields. \u003cstrong\u003eYou will be required to use custom code hooks to populate and set any custom fields\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE: (DEPRECATED)\u003c/strong\u003e This can also be accomplished by using \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L361"\u003e\u003ccode\u003ecustom_field:\u003c/code\u003e\u003c/a\u003e, however we intend to move away from this approach.\u003c/p\u003e\n\u003cp\u003e\u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L361"\u003eRelevant \u003ccode\u003eTODO\u003c/code\u003e for combining CustomShape stuff into \u003ccode\u003etype:\u003c/code\u003e override\u003c/a\u003e\u003c/p\u003e\n\u003ch2 id="custom-code-hook-points"\u003eCustom code hook points\u003c/h2\u003e\n\u003cp\u003eThe code generator will generate Go code that implements the \u003ccode\u003eaws-sdk-go\u003c/code\u003e SDK \u0026ldquo;binding\u0026rdquo; calls. Sometimes you will want to inject bits of custom code at various points in the code generation pipeline.\u003c/p\u003e\n\u003cp\u003eCustom code \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/160b839fe09dd7e1f321e094604ffc3b6ae2a285/pkg/generate/ack/hook.go#L28"\u003ehook points\u003c/a\u003e do this injection. They should be preferred versus using complete overrides (e.g., \u003ccode\u003eresources[$resource].update_operation.custom_method_name\u003c/code\u003e). The reason that custom code hooks are preferred is because you generally want to maximize the amount of \u003cem\u003egenerated\u003c/em\u003e code and minimize the amount of \u003cem\u003ehand-written\u003c/em\u003e code in each controller. \u003cem\u003e[NOTE(jljaco): decide later whether to bother documenting complete overrides via \u003ccode\u003eupdate_operation.custom_method_name\u003c/code\u003e]\u003c/em\u003e\u003c/p\u003e\n\u003ch3 id="the-sdkgo-hook-points"\u003eThe \u003ccode\u003esdk.go\u003c/code\u003e hook points\u003c/h3\u003e\n\u003cp\u003eFirst, some background. Within the \u003ccode\u003epkg/resources/$resource/sdk.go\u003c/code\u003e file, there are 4 primary resource manager methods that control CRUD operations on a resource:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003esdkFind\u003c/code\u003e reads a single resource record from a backend AWS service API, then populates a custom resource representation of that record and returns it back to the reconciler.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkCreate\u003c/code\u003e takes the desired custom resource state (in the \u003ccode\u003eSpec\u003c/code\u003e struct of the CR). It calls AWS service APIs to create the resource in AWS, then sets certain fields on the custom resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct that represent the latest observed state of that resource.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkUpdate\u003c/code\u003e takes the desired custom resource state (from the \u003ccode\u003eSpec\u003c/code\u003e struct of the CR), the latest observed resource state, and a representation of the differences between those (called a \u003ccode\u003eDelta\u003c/code\u003e struct). It calls one or more AWS service APIs to modify a resource\u0026rsquo;s attributes, then populates the custom resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct with the latest (post-modification) observed state of the resource.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkDelete\u003c/code\u003e calls one or more AWS service APIs to delete a resource.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor all 4 of these main ResourceManager methods, there is a consistent code path that looks like this:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003cstrong\u003eConstruct the SDK Input shape\u003c/strong\u003e. For \u003ccode\u003esdkFind\u003c/code\u003e and \u003ccode\u003esdkDelete\u003c/code\u003e, this Input shape will contain the identifier of the resource (e.g. an \u003ccode\u003eARN\u003c/code\u003e). For \u003ccode\u003esdkCreate\u003c/code\u003e and \u003ccode\u003esdkUpdate\u003c/code\u003e, this Input shape will also contain various desired state fields for the resource. This is called the \u0026ldquo;\u003cstrong\u003eSet SDK\u003c/strong\u003e\u0026rdquo; stage and corresponds to code generator functions in code-generator\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/generate/code/set_sdk.go"\u003e\u003ccode\u003epkg/generate/code/set_sdk.go\u003c/code\u003e\u003c/a\u003e.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003ePass the SDK Input shape\u003c/strong\u003e to the \u003ccode\u003eaws-sdk-go\u003c/code\u003e API method.\n\u003cul\u003e\n\u003cli\u003eFor \u003ccode\u003esdkFind\u003c/code\u003e, this API method will be \u003cem\u003eeither\u003c/em\u003e the \u003ccode\u003eReadOne\u003c/code\u003e operation for the resource (e.g., ECR\u0026rsquo;s \u003ccode\u003eGetRepository\u003c/code\u003e or RDS\u0026rsquo;s \u003ccode\u003eDescribeDBInstance\u003c/code\u003e) or the \u003ccode\u003eReadMany\u003c/code\u003e operation (e.g., S3\u0026rsquo;s \u003ccode\u003eListBuckets\u003c/code\u003e or EC2\u0026rsquo;s \u003ccode\u003eDescribeInstances\u003c/code\u003e).\u003c/li\u003e\n\u003cli\u003eFor the \u003ccode\u003esdkCreate\u003c/code\u003e, \u003ccode\u003esdkUpdate\u003c/code\u003e and \u003ccode\u003esdkDelete\u003c/code\u003e methods, the API operation will correspond to the \u003ccode\u003eCreate\u003c/code\u003e, \u003ccode\u003eUpdate\u003c/code\u003e and \u003ccode\u003eDelete\u003c/code\u003e operation types.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eProcess the error/return code\u003c/strong\u003e from the API call. If there is an error that appears in the list of Terminal codes (\u003cstrong\u003eTODO(jljaco) link to docs\u003c/strong\u003e), then the custom resource will have a Terminal condition applied to it, and a Terminal error is returned to the reconciler. The reconciler will subsequently add a \u003ccode\u003eACK.Terminal\u003c/code\u003e Condition to the custom resource.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eProcess the Output shape\u003c/strong\u003e from the API call. If no error was returned from the API call, the Output shape representing the HTTP response content will then be processed, resulting in fields in either the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e of the custom resource being set to the value of matching fields on the Output shape. This is called the \u0026ldquo;\u003cstrong\u003eSet Resource\u003c/strong\u003e\u0026rdquo; stage and corresponds to code generator functions in code-generator\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/generate/code/set_resource.go"\u003e\u003ccode\u003epkg/generate/code/set_resource.go\u003c/code\u003e\u003c/a\u003e.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eAlong with the above 4 main ResourceManager methods, there are a number of generated helper methods and functions that will:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ecreate the SDK input shape used when making HTTP requests to AWS APIs\u003c/li\u003e\n\u003cli\u003eprocess responses from those AWS APIs\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch4 id="sdk__pre_build_request-before-validation-and-construction-of-input-shape"\u003e\u003ccode\u003esdk_*_pre_build_request\u003c/code\u003e: before validation and construction of Input shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003esdk_*_pre_build_request\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e the call to construct the Input shape that is used in the API operation and therefore \u003cem\u003ebefore\u003c/em\u003e any call to validate that Input shape.\u003c/p\u003e\n\u003cp\u003eUse this custom hook point if you want to short-circuit the processing of the resource for some reason \u003cstrong\u003eOR\u003c/strong\u003e if you want to process certain resource fields (e.g., Tags) separately from the main resource fields.\u003c/p\u003e\n\u003ch5 id="example-short-circuiting"\u003eExample: Short-circuiting\u003c/h5\u003e\n\u003cp\u003eHere is an example from the DynamoDB controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/ce5980c26538b0d9310a2526a845a77da2d2f611/generator.yaml#L1"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file that uses a \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/ce5980c26538b0d9310a2526a845a77da2d2f611/generator.yaml#L36"\u003e\u003ccode\u003epre_build_request\u003c/code\u003e\u003c/a\u003e custom code hook for Table resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Table:\n hooks:\n sdk_delete_pre_build_request:\n template_path: hooks/table/sdk_delete_pre_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, the hook is for the Delete operation. You can specify the filepath to a template which contains Go code that you wish to inject at this custom hook point. Here is the \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/1e4563776d5efe9455cb7a347d73cc298f6f16b9/templates/hooks/table/sdk_delete_pre_build_request.go.tpl#L0-L1"\u003eGo code from that template\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e if isTableDeleting(r) {\n return nil, requeueWaitWhileDeleting\n }\n if isTableUpdating(r) {\n return nil, requeueWaitWhileUpdating\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe snippet of Go code above simply requeues the resource to be deleted in the future if the Table is currently either being updated (via \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html"\u003e\u003ccode\u003eUpdateTable\u003c/code\u003e\u003c/a\u003e) or deleted (via \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html"\u003e\u003ccode\u003eDeleteTable\u003c/code\u003e\u003c/a\u003e).\u003c/p\u003e\n\u003cp\u003eAfter running \u003ccode\u003emake build-controller\u003c/code\u003e for DynamoDB, the above \u003ccode\u003egenerator.yaml\u003c/code\u003e configuration and corresponding template file produces the following Go code implementation for \u003ccode\u003esdkDelete\u003c/code\u003e inside of the \u003ccode\u003esdk.go\u003c/code\u003e file for Table resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// sdkDelete deletes the supplied resource in the backend AWS service API\nfunc (rm *resourceManager) sdkDelete(\n ctx context.Context,\n r *resource,\n) (latest *resource, err error) {\n rlog := ackrtlog.FromContext(ctx)\n exit := rlog.Trace(\u0026quot;rm.sdkDelete\u0026quot;)\n defer func() {\n exit(err)\n }()\n\u0026gt; if isTableDeleting(r) {\n\u0026gt; return nil, requeueWaitWhileDeleting\n\u0026gt; }\n\u0026gt; if isTableUpdating(r) {\n\u0026gt; return nil, requeueWaitWhileUpdating\n\u0026gt; }\n input, err := rm.newDeleteRequestPayload(r)\n if err != nil {\n return nil, err\n }\n var resp *svcsdk.DeleteTableOutput\n _ = resp\n resp, err = rm.sdkapi.DeleteTableWithContext(ctx, input)\n rm.metrics.RecordAPICall(\u0026quot;DELETE\u0026quot;, \u0026quot;DeleteTable\u0026quot;, err)\n return nil, err\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the example above, we\u0026rsquo;ve highlighted the lines (with \u003ccode\u003e\u0026gt;\u003c/code\u003e) that were injected into the \u003ccode\u003esdkDelete\u003c/code\u003e method using this custom hook point.\u003c/p\u003e\n\u003ch5 id="example-custom-field-processing"\u003eExample: Custom field processing\u003c/h5\u003e\n\u003cp\u003eAnother example of a \u003ccode\u003epre_build_request\u003c/code\u003e custom hook comes from the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L122"\u003eRole resource\u003c/a\u003e and this \u003ccode\u003egenerator.yaml\u003c/code\u003e snippet:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Role:\n hooks:\n sdk_update_pre_build_request:\n template_path: hooks/role/sdk_update_pre_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003ewhich has the following \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L122"\u003eGo code in the template file\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e if delta.DifferentAt(\u0026quot;Spec.Policies\u0026quot;) {\n err = rm.syncPolicies(ctx, desired, latest)\n if err != nil {\n return nil, err\n }\n }\n if delta.DifferentAt(\u0026quot;Spec.Tags\u0026quot;) {\n err = rm.syncTags(ctx, desired, latest)\n if err != nil {\n return nil, err\n }\n }\n if delta.DifferentAt(\u0026quot;Spec.PermissionsBoundary\u0026quot;) {\n err = rm.syncRolePermissionsBoundary(ctx, desired)\n if err != nil {\n return nil, err\n }\n }\n if !delta.DifferentExcept(\u0026quot;Spec.Tags\u0026quot;, \u0026quot;Spec.Policies\u0026quot;, \u0026quot;Spec.PermissionsBoundary\u0026quot;) {\n return desired, nil\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhat you can see above is the use of the \u003ccode\u003epre_build_request\u003c/code\u003e hook point to update the Role\u0026rsquo;s policy collection, tag collection, and permissions boundary \u003cem\u003ebefore\u003c/em\u003e calling the \u003ccode\u003eUpdateRole\u003c/code\u003e API call. The reason for this is because a Role\u0026rsquo;s policies, tags, and permissions boundary are set using a different set of AWS API calls.\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003eTOP TIP (1)\u003c/strong\u003e:\nNote the use of \u003ccode\u003edelta.DifferentAt()\u003c/code\u003e in the code above. This is the recommended best practice for determining whether a particular field at a supplied field path has diverged between the desired and latest observed resource state.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003ch4 id="sdk__post_build_request-after-construction-of-input-shape"\u003e\u003ccode\u003esdk_*_post_build_request\u003c/code\u003e: after construction of Input shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_build_request\u003c/code\u003e hooks are called AFTER the call to construct the Input shape but \u003cem\u003ebefore\u003c/em\u003e the API operation.\u003c/p\u003e\n\u003cp\u003eUse this custom hook point if you want to add custom validation of the Input shape.\u003c/p\u003e\n\u003cp\u003eHere\u0026rsquo;s an example of a \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L196"\u003e\u003ccode\u003epost_build_request\u003c/code\u003e custom hook point\u003c/a\u003e from the RDS controller\u0026rsquo;s DBInstance resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n hooks:\n sdk_update_post_build_request:\n template_path: hooks/db_instance/sdk_update_post_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eand here\u0026rsquo;s the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/b0d7dadfce38d293df637b24479ac0a85c764ad9/templates/hooks/db_instance/sdk_update_post_build_request.go.tpl#L0-L1"\u003eGo code in that template\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e // ModifyDBInstance call will return ValidationError when the\n // ModifyDBInstanceRequest contains the same DBSubnetGroupName\n // as the DBInstance. So, if there is no delta between\n // desired and latest for Spec.DBSubnetGroupName, exclude it\n // from ModifyDBInstanceRequest\n if !delta.DifferentAt(\u0026quot;Spec.DBSubnetGroupName\u0026quot;) {\n input.DBSubnetGroupName = nil\n }\n\n // RDS will not compare diff value and accept any modify db call\n // for below values, MonitoringInterval, CACertificateIdentifier\n // and user master password, NetworkType\n // hence if there is no delta between desired\n // and latest, exclude it from ModifyDBInstanceRequest\n if !delta.DifferentAt(\u0026quot;Spec.MonitoringInterval\u0026quot;) {\n input.MonitoringInterval = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.CACertificateIdentifier\u0026quot;) {\n input.CACertificateIdentifier = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.MasterUserPassword.Name\u0026quot;) {\n input.MasterUserPassword = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.NetworkType\u0026quot;) {\n input.NetworkType = nil\n }\n\n // For dbInstance inside dbCluster, it\'s either aurora or\n // multi-az cluster case, in either case, the below params\n // are not controlled in instance level.\n // hence when DBClusterIdentifier appear, set them to nil\n // Please refer to doc : https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html\n if desired.ko.Spec.DBClusterIdentifier != nil {\n input.AllocatedStorage = nil\n input.BackupRetentionPeriod = nil\n input.PreferredBackupWindow = nil\n input.DeletionProtection = nil\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, we add some custom validation and normalization of the Input shape for a DBInstance before calling the \u003ccode\u003eModifyDBInstance\u003c/code\u003e API call.\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003eTOP TIP (2)\u003c/strong\u003e:\nNote the verbose usage of nil-checks. \u003cstrong\u003e\u003cem\u003eThis is very important\u003c/em\u003e\u003c/strong\u003e. \u003ccode\u003eaws-sdk-go\u003c/code\u003e does not have automatic protection against \u003ccode\u003enil\u003c/code\u003e pointer dereferencing. \u003cem\u003eAll\u003c/em\u003e fields in an \u003ccode\u003eaws-sdk-go\u003c/code\u003e shape are \u003cstrong\u003epointer types\u003c/strong\u003e. This means you should \u003cstrong\u003ealways\u003c/strong\u003e do your own nil-checks when dereferencing \u003cstrong\u003eany\u003c/strong\u003e field in \u003cstrong\u003eany\u003c/strong\u003e shape.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003ch4 id="sdk__post_request-after-the-api-operation"\u003e\u003ccode\u003esdk_*_post_request\u003c/code\u003e: after the API operation\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_request\u003c/code\u003e hooks are called IMMEDIATELY AFTER the API operation \u003ccode\u003eaws-sdk-go\u003c/code\u003e client call. These hooks will have access to a Go variable named \u003ccode\u003eresp\u003c/code\u003e that refers to the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client response and a Go variable named \u003ccode\u003erespErr\u003c/code\u003e that refers to any error returned from the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client call.\u003c/p\u003e\n\u003ch4 id="sdk__pre_set_output-before-validation-of-output-shape"\u003e\u003ccode\u003esdk_*_pre_set_output\u003c/code\u003e: before validation of Output shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epre_set_output\u003c/code\u003e hooks are called BEFORE the code that processes the Output shape (the \u003ccode\u003epkg/generate/code.SetOutput\u003c/code\u003e function). These hooks will have access to a Go variable named \u003ccode\u003eko\u003c/code\u003e that represents the concrete Kubernetes CR object that will be returned from the main method (\u003ccode\u003esdkFind\u003c/code\u003e, \u003ccode\u003esdkCreate\u003c/code\u003e, etc). This \u003ccode\u003eko\u003c/code\u003e variable will have been defined immediately before the \u003ccode\u003epre_set_output\u003c/code\u003e hooks as a copy of the resource that is supplied to the main method, like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e // Merge in the information we read from the API call above to the copy of\n // the original Kubernetes object we passed to the function\n ko := r.ko.DeepCopy()\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="sdk__post_set_output-after-merging-data-from-api-response--k8s-object"\u003e\u003ccode\u003esdk_*_post_set_output\u003c/code\u003e: after merging data from API response \u0026amp; k8s object\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_set_output\u003c/code\u003e hooks are called AFTER the the information from the API call is merged with the copy of the original Kubernetes object. These hooks will have access to the updated Kubernetes object \u003ccode\u003eko\u003c/code\u003e, the response of the API call (and the original Kubernetes CR object if it\u0026rsquo;s \u003ccode\u003esdkUpdate\u003c/code\u003e).\u003c/p\u003e\n\u003ch4 id="sdk_file_end--miscellaneous-catch-all"\u003e\u003ccode\u003esdk_file_end\u003c/code\u003e: miscellaneous catch-all\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003esdk_file_end\u003c/code\u003e is a generic hook point that occurs outside the scope of any specific \u003ccode\u003eAWSResourceManager\u003c/code\u003e method and can be used to place commonly-generated code inside the \u003ccode\u003esdk.go\u003c/code\u003e file.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003e\u003cem\u003eNOTE(jaypipes): This is the weirdest of the hooks\u0026hellip; need to cleanly explain this!\u003c/em\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003ch3 id="the-comparison-hook-points"\u003eThe comparison hook points\u003c/h3\u003e\n\u003ch4 id="delta_pre_compare-before-comparing-resources"\u003e\u003ccode\u003edelta_pre_compare\u003c/code\u003e: before comparing resources\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003edelta_pre_compare\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e the generated code that compares two resources.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: If you specified that a particular field should have its \u003cstrong\u003ecomparison code ignored\u003c/strong\u003e, you almost always will want to use a \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook to handle the comparison logic for that field. See the \u003ca href="#delta_pre_compare_example_1"\u003eexample above\u003c/a\u003e in the section on \u0026ldquo;\u003cem\u003eMarking a field as ignored\u003c/em\u003e\u0026rdquo; for an illustration of this.\u003c/p\u003e\n\u003cp\u003eThe canonical example of when and how to use this custom code hook point is for handling the correct comparison of slices of Tag structs.\u003c/p\u003e\n\u003cp\u003eBy default, if the code generator does not know how to generate specialized comparison code for a Go type, it will generate a call to \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e for this comparison. However, for some types (e.g., lists-of-structs), \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e will return \u003ccode\u003etrue\u003c/code\u003e \u003cem\u003eeven when the only difference between two lists lies in the order by which the structs are sorted\u003c/em\u003e. This sort order needs to be ignored in order that the comparison logic properly returns \u003ccode\u003efalse\u003c/code\u003e for lists-of-structs that are identical regardless of sort order.\u003c/p\u003e\n\u003cp\u003eThe IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L124"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file contains this snippet:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e Role:\n hooks:\n delta_pre_compare:\n code: compareTags(delta, a, b)\n fields:\n Tags:\n compare:\n is_ignored: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eand the \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook code is an inline Go code function call to \u003ccode\u003ecompareTags\u003c/code\u003e. This function is \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/pkg/resource/role/hooks.go#L188-L202"\u003edefined in the \u003ccode\u003ehooks.go\u003c/code\u003e file\u003c/a\u003e for the Role resource and looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// compareTags is a custom comparison function for comparing lists of Tag\n// structs where the order of the structs in the list is not important.\nfunc compareTags(\n delta *ackcompare.Delta,\n a *resource,\n b *resource,\n) {\n if len(a.ko.Spec.Tags) != len(b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n } else if len(a.ko.Spec.Tags) \u0026gt; 0 {\n if !commonutil.EqualTags(a.ko.Spec.Tags, b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n }\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/pkg/util/tags.go#L22-L59"\u003e\u003ccode\u003ecommonutil.EqualTags\u003c/code\u003e\u003c/a\u003e properly handles the comparison of lists of Tag structs.\u003c/p\u003e\n\u003ch4 id="delta_post_compare-after-comparing-resources"\u003e\u003ccode\u003edelta_post_compare\u003c/code\u003e: after comparing resources\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003edelta_post_compare\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e the generated code that compares two resources.\u003c/p\u003e\n\u003cp\u003eThis hook is not commonly used, since the \u003ccode\u003edelta_pre_compare\u003c/code\u003e custom code hook point is generally used to inject custom code for comparing special fields.\u003c/p\u003e\n\u003cp\u003eHowever, the \u003ccode\u003edelta_post_compare\u003c/code\u003e hook point can be useful if you want to add some code that can post-process the Delta struct \u003cem\u003eafter all fields\u003c/em\u003e have been compared. For example, if you wanted to output some debugging information about the comparison operations.\u003c/p\u003e\n\u003ch3 id="the-late-initialization-hook-points"\u003eThe late initialization hook points\u003c/h3\u003e\n\u003ch4 id="late_initialize_pre_read_one-before-the-readone"\u003e\u003ccode\u003elate_initialize_pre_read_one\u003c/code\u003e: before the \u003ccode\u003ereadOne\u003c/code\u003e\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003elate_initialize_pre_read_one\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e making the \u003ccode\u003ereadOne\u003c/code\u003e call inside the \u003ccode\u003eAWSResourceManager.LateInitialize()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="late_initialize_post_read_one-after-the-readone"\u003e\u003ccode\u003elate_initialize_post_read_one\u003c/code\u003e: after the \u003ccode\u003ereadOne\u003c/code\u003e\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003elate_initialize_post_read_one\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e making the \u003ccode\u003ereadOne\u003c/code\u003e call inside the \u003ccode\u003eAWSResourceManager.LateInitialize()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch3 id="the-reference-hook-points"\u003eThe reference hook points\u003c/h3\u003e\n\u003ch4 id="references_pre_resolve-before-resolving-references"\u003e\u003ccode\u003ereferences_pre_resolve\u003c/code\u003e: before resolving references\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003ereferences_pre_resolve\u003c/code\u003e hook is called \u003cem\u003ebefore\u003c/em\u003e resolving the references for all Reference fields inside the \u003ccode\u003eAWSResourceManager.ResolveReferences()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="references_post_resolve-after-resolving-references"\u003e\u003ccode\u003ereferences_post_resolve\u003c/code\u003e: after resolving references\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003ereferences_post_resolve\u003c/code\u003e hook is called \u003cem\u003eafter\u003c/em\u003e resolving the references for all Reference fields inside the \u003ccode\u003eAWSResourceManager.ResolveReferences()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch3 id="the-tags-hook-points"\u003eThe tags hook points\u003c/h3\u003e\n\u003ch4 id="ensure_tags-custom-ensuretags-method"\u003e\u003ccode\u003eensure_tags\u003c/code\u003e: custom \u003ccode\u003eEnsureTags\u003c/code\u003e method\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003eensure_tags\u003c/code\u003e hook provides a complete custom implementation for the \u003ccode\u003eAWSResourceManager.EnsureTags()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags-custom-toacktags-and-fromacktags-methods"\u003e\u003ccode\u003econvert_tags\u003c/code\u003e: custom \u003ccode\u003eToACKTags\u003c/code\u003e and \u003ccode\u003eFromACKTags\u003c/code\u003e methods\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags\u003c/code\u003e hook provides a complete custom implementation for the \u003ccode\u003eToACKTags\u003c/code\u003e and \u003ccode\u003eFromACKTags\u003c/code\u003e methods.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_pre_to_ack_tags-before-converting-k8s-tags-to-ack-tags"\u003e\u003ccode\u003econvert_tags_pre_to_ack_tags\u003c/code\u003e: before converting k8s tags to ACK tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_pre_to_ack_tags\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e converting the K8s resource tags into ACK tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_post_to_ack_tags-after-converting-k8s-tags-to-ack-tags"\u003e\u003ccode\u003econvert_tags_post_to_ack_tags\u003c/code\u003e: after converting k8s tags to ACK tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_post_to_ack_tags\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e converting the K8s resource tags into ACK tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_pre_from_ack_tags-before-converting-ack-tags-to-k8s-tags"\u003e\u003ccode\u003econvert_tags_pre_from_ack_tags\u003c/code\u003e: before converting ACK tags to k8s tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_pre_from_ack_tags\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e converting the ACK tags into K8s resource tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_post_from_ack_tags-after-converting-ack-tags-to-k8s-tags"\u003e\u003ccode\u003econvert_tags_post_from_ack_tags\u003c/code\u003e: after converting ACK tags to k8s tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_post_from_ack_tags\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e converting the ACK tags into K8s resource tags.\nTODO\u003c/p\u003e\n\u003ch2 id="attribute-based-apis"\u003eAttribute-based APIs\u003c/h2\u003e\n\u003cp\u003e\u003cstrong\u003eOMG TODO.\u003c/strong\u003e\u003c/p\u003e\n\u003ch2 id="miscellaneousmaybe-cover-laterdocumentation-backlog"\u003eMiscellaneous/maybe cover later/documentation backlog\u003c/h2\u003e\n\u003ch3 id="what-does-prefixconfig-do"\u003eWhat does PrefixConfig do?\u003c/h3\u003e\n\u003ch3 id="what-if-the-code-generator-cannot-figure-out-my-services-api-model-name"\u003eWhat if the code generator cannot figure out my service\u0026rsquo;s API model name?\u003c/h3\u003e\n\u003ch3 id="list_operationmatch_fields"\u003elist_operation.match_fields\u003c/h3\u003e\n'}).add({id:34,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/leader-election/",title:"Managing multiple instances of ACK with leader election",description:"Configure leader election for ACK controllers",content:'\u003cp\u003eIn a Kubernetes cluster, you may want to run multiple instances of any ACK\ncontroller - configured for different accounts or regions, or for fail state\nrollover.\nHowever, to avoid conflicts and ensure proper resource management, it\u0026rsquo;s necessary\nto designate one instance as the leader, which takes responsibility for executing\ncertain operations while the other instances remain passive. In the event that\nthe leader instance fails, \u003ca href="https://kubernetes.io/docs/concepts/architecture/leases/#leader-election"\u003eleader election\u003c/a\u003e ensures the seamless\ntransition of leadership to another healthy instance.\u003c/p\u003e\n\u003cp\u003eBy default, leader election is disabled in the ACK Helm charts. However, once\nenabled, you gain the flexibility to scale the default deployment of ACK controllers\nfrom a single replica (1) to a higher number.\u003c/p\u003e\n\u003ch2 id="enabling-leader-election-for-ack-controllers"\u003eEnabling Leader Election for ACK Controllers\u003c/h2\u003e\n\u003cp\u003eTo enable leader election when installing an ACK controller, set the\n\u003ccode\u003eleaderElection.enabled\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e in the helm chart \u003ccode\u003evalues.yaml\u003c/code\u003e like:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eleaderElection:\n enabled: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou also have the flexibility to scale the number of controller replicas. Edit\nthe \u003ccode\u003edeployment.replicas\u003c/code\u003e configuration in the same \u003ccode\u003evalues.yaml\u003c/code\u003e file and\nadjust it to your desired count, such as:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeployment:\n replicas: 3\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="configuring-leader-election-namespace"\u003eConfiguring Leader Election \u003ccode\u003eNamespace\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe leader election namespace is a controller configuration setting that\ndetermines the namespace where controllers manage leader election. Under the\nhood it is used for storing \u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e objects, which help\ncontrollers reach consensus and choose a leader. If not specified, the system\nwill use the namespace from the service account\u0026rsquo;s configuration by default.\u003c/p\u003e\n\u003cp\u003eIf you would like to set leader election namespace for your ACK controllers,\nyou need to set \u003ccode\u003eleaderElection.namespace\u003c/code\u003e, like below:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eleaderElection:\n enabled: true\n namespace: \u0026quot;ack-leader-election-ns\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="verifying-leader-election"\u003eVerifying Leader Election\u003c/h2\u003e\n\u003cp\u003eTo confirm that leader election is active, you can perform the following checks:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003cstrong\u003eLog Messages\u003c/strong\u003e: Examine the logs of your ACK controller pods for any messages\nindicating the successful execution of leader election.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003e\u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e Objects\u003c/strong\u003e: You can also inspect the\n\u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e objects within the configured leader election\nnamespace. Using \u003ccode\u003ekubectl\u003c/code\u003e you can retrieve information about these objects,\nallowing you to verify leadership status.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eKubernetes Events\u003c/strong\u003e: Another method is to monitor Kubernetes events related to your\ncontrollers. Execute \u003ccode\u003ekubectl get events\u003c/code\u003e to view events that might provide insights\ninto leader election and controller behavior.\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:35,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/authorization/",title:"Permissions Overview",description:"Configuring RBAC and IAM for ACK",content:'\u003cp\u003eThere are two different Role-Based Access Control (RBAC) systems needed for ACK service controller authorization: Kubernetes RBAC and AWS IAM.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThis guide is only informative. You do not need to execute any commands from this page.\u003c/p\u003e\n\u003cp\u003eKubernetes RBAC permissions below are already handled when you install ACK service\ncontroller using \u003ca href="../install"\u003eHelm chart or static manifests\u003c/a\u003e\u003c/p\u003e\n\u003cp\u003eAWS IAM permissions are handled using the IAM role created during \u003ca href="../irsa"\u003eIRSA setup\u003c/a\u003e\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003e\u003ca href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/"\u003eKubernetes RBAC\u003c/a\u003e governs a Kubernetes user\u0026rsquo;s ability to read or write Kubernetes resources, while \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html"\u003eAWS Identity and Access Management\u003c/a\u003e (IAM) policies govern the ability of an AWS IAM role to read or write AWS resources.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n These two RBAC systems to not overlap\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The Kubernetes user that makes a Kubernetes API call with \u003ccode\u003ekubectl\u003c/code\u003e has no\nassociation with an IAM role. Instead, the IAM role is associated with the\n\u003ca href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/"\u003eservice account\u003c/a\u003e\nthat runs the ACK service controller\u0026rsquo;s pod.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eRefer to the following diagram for more details on running a Kubernetes API server with RBAC authorization mode enabled.\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/authorization.png" alt="Authorization in ACK"\u003e\u003c/p\u003e\n\u003cp\u003eYou will need to configure Kubernetes RBAC and AWS IAM permissions before using ACK service controllers.\u003c/p\u003e\n\u003ch2 id="kubernetes-rbac"\u003eKubernetes RBAC\u003c/h2\u003e\n\u003ch3 id="permissions-required-for-the-ack-service-controller"\u003ePermissions required for the ACK service controller\u003c/h3\u003e\n\u003cp\u003eACK service controllers may be started in either \u003cem\u003eCluster Mode\u003c/em\u003e or \u003cem\u003eNamespace\nMode\u003c/em\u003e. Controllers started in Cluster Mode watch for new, updated and deleted\ncustom resources (CRs) in all Kubernetes \u003ccode\u003eNamespaces\u003c/code\u003e. Conversely, controllers\nstarted in Namespace Mode only watch for CRs in a single Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e\nidentified by the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003ch4 id="namespace-mode"\u003eNamespace Mode\u003c/h4\u003e\n\u003cp\u003eWhen a service controller is started in Namespace Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e\nflag is supplied and the controller will \u003cem\u003eonly\u003c/em\u003e watch for custom resources\n(CRs) in that Kubernetes Namespace.\u003c/p\u003e\n\u003cp\u003eControllers started in Namespace Mode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the controller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eRole\u003c/code\u003e with\npermissions to create, update/patch, delete, read, list and watch ACK custom\nresources matching the associated AWS service in the specific Kubernetes\n\u003ccode\u003eNamespace\u003c/code\u003e identified by the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n The \u003ccode\u003einstallScope: namespace\u003c/code\u003e Helm Chart value\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you are installing an ACK service controller via the associated Helm Chart,\nyou can simplify a Namespace Mode installation by setting the \u003ccode\u003einstallScope\u003c/code\u003e\nvalue to \u003ccode\u003enamespace\u003c/code\u003e. This will cause the Helm Chart to install a\nnamespace-scoped \u003ccode\u003eRoleBinding\u003c/code\u003e with the necessary permissions the controller\nneeds to create, update, read, list and watch the ACK custom resources managed\nby the controller.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="cluster-mode"\u003eCluster Mode\u003c/h3\u003e\n\u003cp\u003eWhen a service controller is started in Cluster Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e\nflag is not supplied and the controller will watch for ACK custom resources\n(CRs) across \u003cem\u003eall\u003c/em\u003e Kubernetes \u003ccode\u003eNamespaces\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eControllers started in Cluster Mode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the controller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eClusterRole\u003c/code\u003e\nwith permissions to create, update/patch, delete, read, list and watch ACK\ncustom resources matching the associated AWS service in \u003cem\u003eall\u003c/em\u003e Kubernetes\n\u003ccode\u003eNamespaces\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eTo support cross-account resource management, controllers started in Cluster\nMode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the\ncontroller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eClusterRole\u003c/code\u003e with permissions to read, list\nand watch \u003cem\u003eall\u003c/em\u003e \u003ccode\u003eNamespace\u003c/code\u003e objects.\u003c/p\u003e\n\u003cp\u003eAdditionally, the \u003ccode\u003eClusterRole\u003c/code\u003e will need permissions to read \u003ccode\u003eConfigMap\u003c/code\u003e\nresources in a specific Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e identified by the environment\nvariable \u003ccode\u003eACK_SYSTEM_NAMESPACE\u003c/code\u003e, defaulting to \u003ccode\u003eack-system\u003c/code\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Cross-account resource management requires Cluster Mode\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you plan to use an ACK service controller to manage resources across many\nAWS accounts (cross-account resource management, or CARM), you \u003cem\u003emust\u003c/em\u003e start the\ncontroller in Cluster Mode.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="permission-to-read-secret-objects"\u003ePermission to read \u003ccode\u003eSecret\u003c/code\u003e objects\u003c/h3\u003e\n\u003cp\u003eSome ACK service controllers will replace plain-text values for some resource\nfields with the value of Kubernetes \u003ccode\u003eSecret\u003c/code\u003e keys.\u003c/p\u003e\n\u003cp\u003eFor controllers started in Namespace Mode, the \u003ccode\u003eRole\u003c/code\u003e must have permissions to\nread \u003ccode\u003eSecret\u003c/code\u003e objects in the Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e identified by the\n\u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003cp\u003eFor controllers started in Cluster Mode, the \u003ccode\u003eClusterRole\u003c/code\u003e must have\npermissions to read \u003ccode\u003eSecret\u003c/code\u003e resources in \u003cem\u003eany Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e within\nwhich ACK custom resources may be launched\u003c/em\u003e.\u003c/p\u003e\n\u003cp\u003eIn order to support the \u003ccode\u003eFieldExport\u003c/code\u003e custom resource, all controllers will\ninstall with permissions to read and patch \u003ccode\u003eConfigMap\u003c/code\u003e and \u003ccode\u003eSecret\u003c/code\u003e resources in\nany namespace. Read the \u003ca href="../field-export/"\u003edocumentation on \u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e for more\ninformation about the RBAC scope.\u003c/p\u003e\n\u003ch3 id="roles-for-reading-and-writing-ack-custom-resources"\u003eRoles for reading and writing ACK custom resources\u003c/h3\u003e\n\u003cp\u003eAs part of installation, Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources are automatically created. These roles contain permissions to modify the Kubernetes custom resources (CRs) that the ACK service controller is responsible for.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n ACK resources are namespace-scoped\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n All Kubernetes CRs managed by an ACK service controller are namespace-scoped resources. There are no cluster-scoped ACK-managed CRs.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eBy default, the following Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources are created when installing an ACK service controller:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003eack-$SERVICE-writer\u003c/code\u003e: a \u003ccode\u003eRole\u003c/code\u003e used for reading and mutating namespace-scoped CRs that the ACK service controller manages.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eack-$SERVICE-reader\u003c/code\u003e: a \u003ccode\u003eRole\u003c/code\u003e used for reading namespaced-scoped CRs that the ACK service controller manages.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor example, installing the ACK service controller for AWS S3 creates the \u003ccode\u003eack-s3-writer\u003c/code\u003e and \u003ccode\u003eack-s3-reader\u003c/code\u003e roles, both with a \u003ccode\u003eGroupKind\u003c/code\u003e of \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e within a specific Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e.\u003c/p\u003e\n\u003ch3 id="bind-a-kubernetes-user-to-a-kubernetes-role"\u003eBind a Kubernetes user to a Kubernetes role\u003c/h3\u003e\n\u003cp\u003eOnce the Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources have been created, you can assign a specific Kubernetes \u003ccode\u003eUser\u003c/code\u003e to a particular \u003ccode\u003eRole\u003c/code\u003e with the \u003ccode\u003ekubectl create rolebinding\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create rolebinding alice-ack-s3-writer --role ack-s3-writer --namespace testing --user alice\nkubectl create rolebinding alice-ack-sns-reader --role ack-sns-reader --namespace production --user alice\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can check the permissions of a particular Kubernetes \u003ccode\u003eUser\u003c/code\u003e with the \u003ccode\u003ekubectl auth can-i\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ekubectl auth can-i create buckets --namespace default\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="aws-iam-permissions-for-ack-controller"\u003eAWS IAM permissions for ACK controller\u003c/h2\u003e\n\u003cp\u003eThe IAM role needs the correct \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html"\u003eIAM policies\u003c/a\u003e for a given ACK service controller. For example, the ACK service controller for AWS S3 needs read and write permission for S3 Buckets. It is recommended that the IAM policy gives only enough access to properly manage the resources needed for a specific AWS service.\u003c/p\u003e\n\u003cp\u003eTo use the recommended IAM policy for a given ACK service controller, refer to the \u003ccode\u003erecommended-policy-arn\u003c/code\u003e file in the \u003ccode\u003econfig/iam/\u003c/code\u003e folder within that service\u0026rsquo;s public repository. This document contains the AWS Resource Name (ARN) of the recommended managed policy for a specific service. For example, the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/tree/main/config/iam"\u003erecommended IAM policy ARN for AWS S3\u003c/a\u003e is: \u003ccode\u003earn:aws:iam::aws:policy/AmazonS3FullAccess\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eSome services may need an additional inline policy. For example, the service controller may require \u003ccode\u003eiam:PassRole\u003c/code\u003e permission in order to pass an execution role that will be assumed by the AWS service. If applicable, resources for additional recommended policies will be located in the \u003ccode\u003erecommended-inline-policy\u003c/code\u003e file within the \u003ccode\u003econfig/iam\u003c/code\u003e folder of a given ACK service controller\u0026rsquo;s public repository. This inline policy is applied along with the managed policies when creating the role.\u003c/p\u003e\n\u003cp\u003eIf you have not yet created an IAM role, see the user documentation on how to \u003ca href="../irsa/#create-an-iam-role-for-your-ack-service-controller"\u003ecreate an IAM role for your ACK service controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:36,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/testing/",title:"Testing",description:"How to test an ACK service controller",content:'\u003cp\u003eIn the following, we will take you through the steps to run end-to-end (e2e)\ntests for the ACK service controller for S3. You may use these steps to run e2e\ntests for other ACK service controllers.\u003c/p\u003e\n\u003cp\u003eIf you run into any problems when testing a service controller, please\n\u003ca href="https://github.com/aws-controllers-k8s/community/issues/new/choose"\u003eraise an issue\u003c/a\u003e\nwith the details so we can reproduce your issue.\u003c/p\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eFor local development and testing we use \u0026ldquo;Kubernetes in Docker\u0026rdquo; (\u003ccode\u003ekind\u003c/code\u003e),\nwhich in turn requires Docker.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Footprint\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When you run the \u003ccode\u003escripts/start.sh\u003c/code\u003e script the first time,\nthe step that builds the container image for the target ACK service controller\ncan take up to 10 or more minutes. This is because the container image contains\na lot of dependencies. Once you successfully built the target image this base\nimage layer is cached locally, and the build takes a much shorter amount of\ntime. We are aware of this and aim to reduce both in the fullness of time.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn summary, in order to test ACK you will need to have the following tools\ninstalled and configured:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="https://golang.org/doc/install"\u003eGolang 1.17+\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003emake\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/get-docker/"\u003eDocker\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kind.sigs.k8s.io/docs/user/quick-start/"\u003ekind\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kubernetes.io/docs/tasks/tools/"\u003ekubectl\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kubectl.docs.kubernetes.io/installation/kustomize/binaries/"\u003ekustomize\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/stedolan/jq/wiki/Installation"\u003ejq\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq/#install"\u003eyq\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eTo build and test an ACK controller with \u003ccode\u003ekind\u003c/code\u003e, \u003cstrong\u003eexecute the commands as\ndescribed in the following from the root directory of the\n\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e repository\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eYou should have forked this repository and \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d it locally when\n\u003ca href="../setup/"\u003esetting up your development environment\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Recommended RAM\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Given that our test setup creates the container images and then launches\na test cluster, we recommend that you have at least 4GB of RAM available\nfor the tests.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eWith the prerequisites out of the way, let\u0026rsquo;s move on to running e2e tests for a\nservice controller.\u003c/p\u003e\n\u003ch2 id="run-tests"\u003eRun tests\u003c/h2\u003e\n\u003cp\u003eTime to run the end-to-end test.\u003c/p\u003e\n\u003ch3 id="test-configuration-file-setup"\u003eTest configuration file setup\u003c/h3\u003e\n\u003cp\u003eThe e2e tests should be configured through a \u003ccode\u003etest_config.yaml\u003c/code\u003e file that lives\nin the root of your \u003ccode\u003etest-infra\u003c/code\u003e directory. We have provided a\n\u003ccode\u003etest_config.example.yaml\u003c/code\u003e file which contains the description for each\nconfiguration option and its default value. Copy this configuration file and\ncustomize it for your own needs:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecp test_config.example.yaml test_config.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTake some time to look over each of the available options in the configuration\nfile and make changes to suit your preferences.\u003c/p\u003e\n\u003ch4 id="iam-setup"\u003eIAM Setup\u003c/h4\u003e\n\u003cp\u003eIn order for the ACK service controller to manage the S3 bucket, it needs an\nidentity. In other words, it needs an IAM role that represents the ACK service\ncontroller towards the S3 service.\u003c/p\u003e\n\u003cp\u003eFirst, define the name of the IAM role that will have the permission to manage\nS3 buckets on your behalf:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_TEST_IAM_ROLE=Admin-k8s\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we need to verify the IAM principal (likely an IAM user) that is going to\nassume the IAM role \u003ccode\u003eACK_TEST_IAM_ROLE\u003c/code\u003e. So to get its ARN, execute:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_TEST_PRINCIPAL_ARN=$(aws sts get-caller-identity --query \'Arn\' --output text)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify if that worked using \u003ccode\u003eecho $ACK_TEST_PRINCIPAL_ARN\u003c/code\u003e and that should\nprint something along the lines of \u003ccode\u003earn:aws:iam::1234567890121:user/ausername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eNext up, create the IAM role, adding the necessary trust relationship to the\nrole, using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026gt; trust-policy.json \u0026lt;\u0026lt; EOF\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;AWS\u0026quot;: \u0026quot;$ACK_TEST_PRINCIPAL_ARN\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;\n }\n}\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUsing above trust policy, we can now create the IAM role:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-role \\\n --role-name $ACK_TEST_IAM_ROLE \\\n --assume-role-policy-document file://trust-policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we\u0026rsquo;re in the position to give the IAM role \u003ccode\u003eACK_TEST_IAM_ROLE\u003c/code\u003e the\npermission to handle S3 buckets for us, using:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam attach-role-policy \\\n --role-name $ACK_TEST_IAM_ROLE \\\n --policy-arn \u0026quot;arn:aws:iam::aws:policy/AmazonS3FullAccess\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IAM policies for other services\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eIf you are running tests on a service other than S3, you will need to find the\nrecommended policy ARN for the given service. The ARN is stored in\n[\u003ccode\u003econfig/iam/recommended-policy-arn\u003c/code\u003e][recc-arn] in each controller repository.\u003c/p\u003e\n\u003cp\u003eSome services don\u0026rsquo;t have a single policy ARN to represent all of the permissions\nrequired to run their controller. Instead you can find an [inline\npolicy][inline-policy] in the\n[\u003ccode\u003econfig/iam/recommended-inline-policy\u003c/code\u003e][recc-inline] in each applicable\ncontroller repository. This can be applied to the role using [\u003ccode\u003eaws iam put-role-policy\u003c/code\u003e][put-role-policy].\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Access delegation in IAM\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you\u0026rsquo;re not that familiar with IAM access delegation, we recommend you\nto peruse the [IAM documentation][iam-docs]\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, in order for our test to generate \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html"\u003etemporary credentials\u003c/a\u003e\nwe need to tell it to use the IAM role we created in the previous step.\nTo generate the IAM role ARN and update your configuration file, do:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \'Account\' --output text) \u0026amp;\u0026amp; \\\nASSUMED_ROLE_ARN=arn:aws:iam::${AWS_ACCOUNT_ID}:role/${ACK_TEST_IAM_ROLE} \\\nyq -i \'.aws.assumed_role_arn = env(ASSUMED_ROLE_ARN)\' test_config.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The tests uses the \u003ccode\u003egenerate_temp_creds\u003c/code\u003e function from the\n\u003ccode\u003escripts/lib/aws.sh\u003c/code\u003e script, executing effectively\n\u003ccode\u003eaws sts assume-role --role-session-arn $ASSUMED_ROLE_ARN --role-session-name $TEMP_ROLE \u003c/code\u003e\nwhich fetches temporarily \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e, \u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e,\nand an \u003ccode\u003eAWS_SESSION_TOKEN\u003c/code\u003e used in turn to authentication the ACK\ncontroller. The duration of the session token is 900 seconds (15 minutes).\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003ePhew that was a lot to set up, but good news: you\u0026rsquo;re almost there.\u003c/p\u003e\n\u003ch3 id="run-end-to-end-test"\u003eRun end-to-end test\u003c/h3\u003e\n\u003cp\u003eBefore you proceed, make sure that you\u0026rsquo;ve done the configuration file setup in\nthe previous step.\u003c/p\u003e\n\u003cp\u003eNow we\u0026rsquo;re finally in the position to execute the end-to-end test:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake kind-test SERVICE=$SERVICE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis provisions a Kubernetes cluster using \u003ccode\u003ekind\u003c/code\u003e, builds a container image with\nthe ACK service controller, and loads the container image into the \u003ccode\u003ekind\u003c/code\u003e\ncluster.\u003c/p\u003e\n\u003cp\u003eIt then installs the ACK service controller and related Kubernetes manifests\ninto the \u003ccode\u003ekind\u003c/code\u003e cluster using \u003ccode\u003ekustomize build | kubectl apply -f -\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eFirst, it will attempt to install the Helm chart for the controller to ensure\nthe default values are safe and that the controller stands up properly.\u003c/p\u003e\n\u003cp\u003eThen, the above script builds a testing container, containing a Python\nenvironment and the testing libraries we use, and runs the e2e tests for the\ncontroller within that environment. These tests create, update and delete each\nof the ACK resources and ensure their properties are properly mirrored in the\nAWS service. The output of the test script should look like the following\n(edited down to the relevant parts):\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e2022-07-15T19:52:55+0000 [INFO] Creating KIND cluster ...\n2022-07-15T19:52:55+0000 [INFO] Creating cluster with name \u0026quot;ack-test-e9e83a17\u0026quot;\n2022-07-15T19:52:55+0000 [INFO] Using configuration \u0026quot;kind-two-node-cluster.yaml\u0026quot;\nCreating cluster \u0026quot;ack-test-e9e83a17\u0026quot; ...\n ✓ Ensuring node image (kindest/node:v1.22.9) 🖼\n ✓ Preparing nodes 📦 📦\n ✓ Writing configuration 📜\n ✓ Starting control-plane 🕹️\n ✓ Installing CNI 🔌\n ✓ Installing StorageClass 💾\n ✓ Joining worker nodes 🚜\nSet kubectl context to \u0026quot;kind-ack-test-e9e83a17\u0026quot;\nYou can now use your cluster with:\n\nkubectl cluster-info --context kind-ack-test-e9e83a17 --kubeconfig /local/home/nithomso/go/src/github.com/aws-controllers-k8s/test-infra/scripts/../build/clusters/ack-test-e9e83a17/kubeconfig\n\nNot sure what to do next? 😅 Check out https://kind.sigs.k8s.io/docs/user/quick-start/\n2022-07-15T19:53:42+0000 [INFO] Exporting KUBECONFIG=/local/home/nithomso/go/src/github.com/aws-controllers-k8s/test-infra/scripts/../build/clusters/ack-test-e9e83a17/kubeconfig\n2022-07-15T19:53:42+0000 [INFO] Building controller image ...\nWARNING! Your password will be stored unencrypted in /home/nithomso/.docker/config.json.\nConfigure a credential helper to remove this warning. See\nhttps://docs.docker.com/engine/reference/commandline/login/#credentials-store\n\n[+] Building 352.7s (21/21) FINISHED\n =\u0026gt; [internal] load build definition from Dockerfile 0.0s\n =\u0026gt; =\u0026gt; transferring dockerfile: 39B 0.0s\n =\u0026gt; [internal] load .dockerignore 0.0s\n =\u0026gt; =\u0026gt; transferring context: 2B 0.0s\n =\u0026gt; [internal] load metadata for public.ecr.aws/eks-distro-build-tooling/eks-distro-minim 0.2s\n =\u0026gt; [internal] load metadata for public.ecr.aws/bitnami/golang:1.17 0.5s\n =\u0026gt; [auth] aws:: eks-distro-build-tooling/eks-distro-minimal-base-nonroot:pull token for 0.0s\n =\u0026gt; [auth] aws:: bitnami/golang:pull token for public.ecr.aws 0.0s\n =\u0026gt; [builder 1/11] FROM public.ecr.aws/bitnami/golang:1.17@sha256:386b0edb486b872c5db270 9.9s\n =\u0026gt; =\u0026gt; resolve public.ecr.aws/bitnami/golang:1.17@sha256:386b0edb486b872c5db2702c997ac364 0.0s\n =\u0026gt; =\u0026gt; sha256:386b0edb486b872c5db2702c997ac364749d5b52908ba2f8db33e67e32c 1.58kB / 1.58kB 0.0s\n =\u0026gt; =\u0026gt; sha256:6474ea435b8fd7c66546676ee6bb9fafdede6679aa57119d3b3e91c23c9 4.25kB / 4.25kB 0.0s\n =\u0026gt; =\u0026gt; sha256:e4d5dd6e67b14bf5bfc57a4ed6126d2ff9618ae17a809ba0eed98b68d 30.87MB / 30.87MB 0.5s\n =\u0026gt; =\u0026gt; sha256:163e77b4424a8a2f2433544cd177d3ab5b67cd42ff2a6332788f2569a53e076 768B / 768B 0.2s\n =\u0026gt; =\u0026gt; sha256:1f31511aab3c72a7f8227e41e7c0b2d71ba2b0bef7c18c9ae8343f9 125.13MB / 125.13MB 4.0s\n =\u0026gt; =\u0026gt; sha256:c9e9361513e51d32efbc5726aa75f2bf6a0ee5d59d5ef002f127bd1 135.04MB / 135.04MB 5.3s\n =\u0026gt; =\u0026gt; extracting sha256:e4d5dd6e67b14bf5bfc57a4ed6126d2ff9618ae17a809ba0eed98b68d62c200d 0.7s\n =\u0026gt; =\u0026gt; sha256:f6e1dc6697990041781953a87be7a91a0b0a30f436b93fc277f2a160fd41f87 258B / 258B 0.6s\n =\u0026gt; =\u0026gt; sha256:6ec6c2b2145be26a5e68b86aadf441144a44f1bba0e70b3cab1988d286814d5 124B / 124B 0.7s\n =\u0026gt; =\u0026gt; extracting sha256:163e77b4424a8a2f2433544cd177d3ab5b67cd42ff2a6332788f2569a53e0769 0.0s\n =\u0026gt; =\u0026gt; extracting sha256:1f31511aab3c72a7f8227e41e7c0b2d71ba2b0bef7c18c9ae8343f9739f78dfa 2.4s\n =\u0026gt; =\u0026gt; extracting sha256:c9e9361513e51d32efbc5726aa75f2bf6a0ee5d59d5ef002f127bd1b503582b3 2.9s\n =\u0026gt; =\u0026gt; extracting sha256:f6e1dc6697990041781953a87be7a91a0b0a30f436b93fc277f2a160fd41f87c 0.0s\n =\u0026gt; =\u0026gt; extracting sha256:6ec6c2b2145be26a5e68b86aadf441144a44f1bba0e70b3cab1988d286814d51 0.0s\n =\u0026gt; CACHED [stage-1 1/3] FROM public.ecr.aws/eks-distro-build-tooling/eks-distro-minimal- 0.0s\n =\u0026gt; [internal] load build context 0.0s\n =\u0026gt; =\u0026gt; transferring context: 567.03kB 0.0s\n =\u0026gt; [builder 2/11] WORKDIR /github.com/aws-controllers-k8s/s3-controller 0.8s\n =\u0026gt; [builder 3/11] COPY s3-controller/LICENSE /github.com/aws-controllers-k8s/s3-control 0.0s\n =\u0026gt; [builder 4/11] COPY s3-controller/ATTRIBUTION.md /github.com/aws-controllers-k8s/s3- 0.0s\n =\u0026gt; [builder 5/11] COPY s3-controller/go.mod /github.com/aws-controllers-k8s/s3-controll 0.0s\n =\u0026gt; [builder 6/11] COPY s3-controller/go.sum /github.com/aws-controllers-k8s/s3-controll 0.0s\n =\u0026gt; [builder 7/11] RUN go mod download 319.2s\n =\u0026gt; [builder 8/11] COPY s3-controller/apis /github.com/aws-controllers-k8s/s3-controller 0.0s\n =\u0026gt; [builder 9/11] COPY s3-controller/cmd /github.com/aws-controllers-k8s/s3-controller/ 0.0s\n =\u0026gt; [builder 10/11] COPY s3-controller/pkg /github.com/aws-controllers-k8s/s3-controller/ 0.0s\n =\u0026gt; [builder 11/11] RUN GIT_VERSION=v0.1.0-dirty \u0026amp;\u0026amp; GIT_COMMIT=46e9abeeae0e5838fdb65 21.4s\n =\u0026gt; [stage-1 2/3] COPY --from=builder /github.com/aws-controllers-k8s/s3-controller/bin/c 0.1s\n =\u0026gt; exporting to image 0.3s\n =\u0026gt; =\u0026gt; exporting layers 0.2s\n =\u0026gt; =\u0026gt; writing image sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064c 0.0s\n =\u0026gt; =\u0026gt; naming to docker.io/library/aws-controllers-k8s:s3-v0.1.0-dirty 0.0s\n2022-07-15T19:59:37+0000 [INFO] Loading image into cluster ...\nImage: \u0026quot;aws-controllers-k8s:s3-v0.1.0-dirty\u0026quot; with ID \u0026quot;sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064cfa8\u0026quot; not yet present on node \u0026quot;ack-test-e9e83a17-worker\u0026quot;, loading...\nImage: \u0026quot;aws-controllers-k8s:s3-v0.1.0-dirty\u0026quot; with ID \u0026quot;sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064cfa8\u0026quot; not yet present on node \u0026quot;ack-test-e9e83a17-control-plane\u0026quot;, loading...\n2022-07-15T19:59:40+0000 [INFO] Installing controller deployment ...\nnamespace/ack-system created\nWarning: resource namespaces/ack-system is missing the kubectl.kubernetes.io/last-applied-configuration annotation which is required by kubectl apply. kubectl apply should only be used on resources created declaratively by either kubectl create --save-config or kubectl apply. The missing annotation will be patched automatically.\n2022-07-15T19:59:47+0000 [INFO] Sleeping for 50 mins before rotating temporary aws credentials\n2022-07-15T19:59:47+0000 [INFO] Building e2e test container for s3 ...\n2022-07-15T20:00:11+0000 [INFO] Running e2e test container for s3 ...\n2022-07-15T20:00:11+00:00 [INFO] Running test bootstrap ...\nINFO:root:🛠️ Bootstrapping resources ...\nINFO:root:Attempting bootstrap Bucket\nINFO:root:Successfully bootstrapped Bucket\nINFO:root:Attempting bootstrap Role\nINFO:root:Attempting bootstrap UserPolicies\nINFO:root:Successfully bootstrapped UserPolicies\nINFO:root:Successfully bootstrapped Role\nINFO:root:Attempting bootstrap Topic\nINFO:root:Successfully bootstrapped Topic\nINFO:root:Wrote bootstrap to /s3-controller/tests/e2e/bootstrap.pkl\n2022-07-15T20:00:18+00:00 [INFO] Running tests ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="repeat-for-other-services"\u003eRepeat for other services\u003c/h4\u003e\n\u003cp\u003eWe have end-to-end tests for all services listed in the \u003ccode\u003eDEVELOPER-PREVIEW\u003c/code\u003e,\n\u003ccode\u003eBETA\u003c/code\u003e and \u003ccode\u003eGA\u003c/code\u003e release statuses in our \u003ca href="../../community/services"\u003eservice listing\u003c/a\u003e\ndocument. Simply replace your \u003ccode\u003eSERVICE\u003c/code\u003e environment variable with the name of a\nsupported service and re-run the IAM and test steps outlined above.\u003c/p\u003e\n\u003ch3 id="unit-testing"\u003eUnit testing\u003c/h3\u003e\n\u003cp\u003eWe use \u003ca href="https://github.com/vektra/mockery"\u003emockery\u003c/a\u003e for unit testing.\nYou can install it by following the guideline on mockery\u0026rsquo;s GitHub or simply\nby running our handy script at \u003ccode\u003e./scripts/install-mockery.sh\u003c/code\u003e for general\nLinux environments.\u003c/p\u003e\n\u003ch2 id="clean-up"\u003eClean up\u003c/h2\u003e\n\u003cp\u003eTo clean up a \u003ccode\u003ekind\u003c/code\u003e cluster, including the container images and configuration\nfiles created by the script specifically for said test cluster, execute:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekind delete cluster --name $CLUSTER_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf you want to delete all \u003ccode\u003ekind\u003c/code\u003e cluster running on your machine, use:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekind delete clusters --all\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWith this the testing is completed. Thanks for your time and we appreciate your\nfeedback.\u003c/p\u003e\n'}).add({id:37,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/authentication/",title:"Authentication and Credentials",description:"Understanding how AWS credentials are determined for an ACK controller",content:'\u003cp\u003eWhen an ACK service controller communicates with an AWS service API, the\ncontroller uses a set of \u003ca href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html"\u003e\u003cem\u003eAWS Credentials\u003c/em\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eThis document explains the process by which these credentials are determined by\nthe ACK service controller and how ACK users can configure the ACK service\ncontroller to use a particular set of credentials.\u003c/p\u003e\n\u003ch2 id="background"\u003eBackground\u003c/h2\u003e\n\u003cp\u003eEach ACK service controller uses the \u003ca href="https://github.com/aws/aws-sdk-go/"\u003e\u003ccode\u003eaws-sdk-go\u003c/code\u003e\u003c/a\u003e library to call\nthe AWS service APIs.\u003c/p\u003e\n\u003cp\u003eWhen initiating communication with an AWS service API, the ACK controller\n\u003ca href="https://github.com/aws-controllers-k8s/runtime/blob/7abfd4e9bf9c835b76e06603617cae50c39af42e/pkg/runtime/session.go#L58"\u003ecreates\u003c/a\u003e a new \u003ccode\u003eaws-sdk-go\u003c/code\u003e \u003ccode\u003eSession\u003c/code\u003e object. This \u003ccode\u003eSession\u003c/code\u003e\nobject is automatically configured during construction by code in the\n\u003ccode\u003eaws-sdk-go\u003c/code\u003e library that \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/session/credentials.go#L19"\u003elooks for credential information\u003c/a\u003e in the\nfollowing places, \u003cem\u003ein this specific order\u003c/em\u003e:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_PROFILE\u003c/code\u003e environment variable is set, \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/session/credentials.go#L85"\u003efind\u003c/a\u003e that\nspecified profile in the configured \u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003ecredentials file\u003c/a\u003e and use\nthat profile\u0026rsquo;s credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e and \u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e environment variables\nare both set, these \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/credentials/env_provider.go#L41-L69"\u003evalues are used\u003c/a\u003e by \u003ccode\u003eaws-sdk-go\u003c/code\u003e to set the\nAWS credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_WEB_IDENTITY_TOKEN_FILE\u003c/code\u003e environment variable is set,\n\u003ccode\u003eaws-sdk-go\u003c/code\u003e will load the credentials from the JSON web token (JWT) present\nin the file pointed to by this environment variable. Note that this\nenvironment variable is set to the value\n\u003ccode\u003e/var/run/secrets/eks.amazonaws.com/serviceaccount/token\u003c/code\u003e by the IAM Roles\nfor Service Accounts (IRSA) pod identity webhook and the contents of this\nfile are automatically rotated by the webhook with temporary credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf there is a credentials file present at the location specified in the\n\u003ccode\u003eAWS_SHARED_CREDENTIALS_FILE\u003c/code\u003e environment variable (or\n\u003ccode\u003e$HOME/.aws/credentials\u003c/code\u003e if empty), \u003ccode\u003eaws-sdk-go\u003c/code\u003e will load the \u0026ldquo;default\u0026rdquo;\nprofile present in the credentials file.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="configuring-credentials"\u003eConfiguring credentials\u003c/h2\u003e\n\u003cp\u003eThere are multiple ways in which you can configure an ACK service controller to\nuse a particular set of AWS credentials:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eWeb identity token file (recommended)\u003c/li\u003e\n\u003cli\u003eShared credentials file\u003c/li\u003e\n\u003cli\u003eAccess key and secret access key environment variables (not recommended)\u003c/li\u003e\n\u003c/ul\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Understand the AWS credentials file format\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It is important to understand the \u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003eAWS credentials file format\u003c/a\u003e,\nespecially if you choose not to use the web identity token file method of\ncredential configuration.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="use-a-web-identity-token-file-recommended"\u003eUse a web identity token file (recommended)\u003c/h3\u003e\n\u003cp\u003eOur recommended approach for configuring the AWS credentials that an ACK\nservice controller will use to communicate with AWS services is to use the IAM\nRoles for Service Accounts (IRSA) functionality provided by the IAM Pod\nIdentity Webhook and OIDC connector.\u003c/p\u003e\n\u003cp\u003eUsing IRSA means that you only need to configure the IAM Role that is\nassociated with the Kubernetes Service Account of the ACK service controller\u0026rsquo;s\nKubernetes Pod. The Pod Identity Webhook will be responsible for automatically\ninjecting \u003cem\u003eand periodically rotating\u003c/em\u003e the web identity token file into your ACK\nservice controller\u0026rsquo;s Pod.\u003c/p\u003e\n\u003cp\u003eLearn \u003ca href="../irsa/"\u003ehow to configure IRSA\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Understand the AWS credentials file format\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n IRSA is enabled and installed on EKS clusters by default, however must be\nmanually configured if you are using a non-EKS cluster. See the IRSA\n\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook/blob/master/SELF_HOSTED_SETUP.md"\u003eself-hosted documentation\u003c/a\u003e for information about installing the\npod identity webhook in non-EKS clusters.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="use-a-shared-credentials-file"\u003eUse a shared credentials file\u003c/h3\u003e\n\u003cp\u003eIf you are not using IAM Roles for Service Accounts (IRSA) or are running in an\nenvironment where IRSA isn\u0026rsquo;t feasible (such as running KinD clusters within\nKubernetes Pods using Docker-in-Docker), you can choose to instruct the ACK\nservice controller to use AWS credentials found in a\n\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003eshared credentials file\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eWhen using a shared credentials file, the ACK service controller will need read\naccess to a known credentials file location.\u003c/p\u003e\n\u003cp\u003eIf you do \u003cem\u003enot\u003c/em\u003e set the \u003ccode\u003eAWS_SHARED_CREDENTIALS_FILE\u003c/code\u003e environment variable, the\ncontroller will look for a readable file at \u003ccode\u003e$HOME/.aws/credentials\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003ePractically, this means that the \u003ccode\u003eDeployment\u003c/code\u003e spec you use to deploy the ACK\nservice controller should have a \u003ca href="https://kubernetes.io/docs/concepts/storage/volumes/"\u003evolume mount\u003c/a\u003e that mounts a\nreadonly file containing the credentials file.\u003c/p\u003e\n\u003cp\u003eLet\u0026rsquo;s assume you have stored your local AWS credentials file content in a\nKubernetes \u003ccode\u003eSecret\u003c/code\u003e named \u003ccode\u003eaws-creds\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eCREDS_CONTENT=$(cat ~/.aws/credentials)\ncat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: Secret\nmetadata:\n name: aws-creds\ntype: Opaque\nstringData:\n credentials-file: |\n $CREDS_CONTENT\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou would want to mount a readonly volume into the \u003ccode\u003eDeployment\u003c/code\u003e for your ACK\nservice controller. Here\u0026rsquo;s how you might do this for a sample ACK controller:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: ack-s3-controller\nspec:\n replicas: 1\n template:\n spec:\n containers:\n - command:\n - ./bin/controller\n image: controller:latest\n name: controller\n ports:\n - name: http\n containerPort: 8080\n resources:\n limits:\n cpu: 100m\n memory: 300Mi\n requests:\n cpu: 100m\n memory: 200Mi\n volumeMounts:\n - name: aws-creds\n mountPath: \u0026quot;/root/.aws/credentials\u0026quot;\n readOnly: true\n volumes:\n - name: aws-creds\n secret:\n secretName: aws-creds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can instruct the service controller to use a specific profile within the\nshared credentials file by setting the \u003ccode\u003eAWS_PROFILE\u003c/code\u003e environment variable for\nthe \u003ccode\u003ePod\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e env:\n - name: AWS_PROFILE\n value: my-profile\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="use-access-key-and-secret-access-key-environment-variables-not-recommended"\u003eUse access key and secret access key environment variables (not recommended)\u003c/h3\u003e\n\u003cp\u003eFinally, you can choose to manually set the \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e,\n\u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e and optionally the \u003ccode\u003eAWS_SESSION_TOKEN\u003c/code\u003e environment\nvariables on the ACK service controller\u0026rsquo;s \u003ccode\u003ePod\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ack-system set env deployment/ack-s3-controller \\\n AWS_ACCESS_KEY_ID=\u0026quot;$AWS_ACCESS_KEY_ID\u0026quot; \\\n AWS_SECRET_ACCESS_KEY=\u0026quot;$AWS_SECRET_ACCESS_KEY\u0026quot; \\\n AWS_SESSION_TOKEN=\u0026quot;$AWS_SESSION_TOKEN\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:38,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/field-export/",title:"Copy a resource field into a ConfigMap or Secret",description:"Using the FieldExport custom resource",content:'\u003cp\u003eACK controllers are intended to manage your AWS infrastructure using Kubernetes\ncustom resources. Their responsibilities end after managing the lifecycle of\nyour AWS resource and do not extend into binding to applications running in the\nKubernetes data plane. The ACK \u003ccode\u003eFieldExport\u003c/code\u003e custom resource was designed to\nbridge the gap between managing the control plane of your ACK resources and\nusing the properties of those resources in your application.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eFieldExport\u003c/code\u003e resource configures an ACK controller to export any spec or\nstatus field from an ACK resource into a Kubernetes \u003ccode\u003eConfigMap\u003c/code\u003e or \u003ccode\u003eSecret\u003c/code\u003e.\nThese fields are automatically updated when any field value changes. You are\nthen able to mount the \u003ccode\u003eConfigMap\u003c/code\u003e or \u003ccode\u003eSecret\u003c/code\u003e onto your Kubernetes Pods as\nenvironment variables that can ingest those values.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eFieldExport\u003c/code\u003e is included by default in every ACK controller installation and\ncan be used to reference any field within the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e of any ACK\nresource.\u003c/p\u003e\n\u003ch2 id="using-a-fieldexport"\u003eUsing a FieldExport\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e fields of the \u003ccode\u003eFieldExport\u003c/code\u003e custom resource definition\nare available in the \u003ca href="../../../reference/common/v1alpha1/fieldexport/"\u003eAPI reference\u003c/a\u003e. For this example, we will\nbe creating an \u003ca href="../../../reference/s3/v1alpha1/fieldexport/bucket/#spec"\u003eS3 Bucket\u003c/a\u003e and exporting the \u003ccode\u003eStatus.Location\u003c/code\u003e\nfield into a \u003ccode\u003eConfigMap\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: application-user-data\nspec:\n name: doc-example-bucket\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: application-user-data-cm\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: export-user-data-bucket\nspec: \n to:\n name: application-user-data-cm # Matches the ConfigMap we created above\n kind: configmap\n from:\n path: \u0026quot;.status.location\u0026quot;\n resource:\n group: s3.services.k8s.aws\n kind: Bucket\n name: application-user-data\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApplying this manifest to the cluster will:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eCreate a new S3 bucket called \u003ccode\u003edoc-example-bucket\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCreate a \u003ccode\u003eConfigMap\u003c/code\u003e called \u003ccode\u003eapplication-user-data-cm\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCreate a \u003ccode\u003eFieldExport\u003c/code\u003e called \u003ccode\u003eexport-user-data-bucket\u003c/code\u003e that will export the\n\u003ccode\u003e.status.location\u003c/code\u003e path from the bucket into the ConfigMap\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eAfter the reconciler has created the bucket, the \u003ccode\u003eapplication-user-data-cm\u003c/code\u003e\n\u003ccode\u003eConfigMap\u003c/code\u003e looks like the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: ConfigMap\nmetadata:\n name: application-user-data-cm\n namespace: default\ndata:\n default.export-user-data-bucket: http://doc-example-bucket.s3.amazonaws.com/\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003eConfigMap\u003c/code\u003e data contains a new key-value pair. The key is the namespace and\nname of the \u003ccode\u003eFieldExport\u003c/code\u003e that created it, and the value is the resolved value\nfrom the resourc. This value can then be included as an environment variable in\na pod like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Pod\nmetadata:\n name: my-application\nspec:\n containers:\n - name: field-export-demo-container\n image: registry.k8s.io/busybox\n command: [ \u0026quot;/bin/sh\u0026quot;, \u0026quot;-c\u0026quot;, \u0026quot;env\u0026quot; ]\n env:\n - name: USER_DATA_BUCKET_LOCATION\n valueFrom:\n configMapKeyRef:\n name: application-user-data-cm # The ConfigMap that we created earlier\n key: \u0026quot;default.export-user-data-bucket\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLooking at the container logs, you can see the \u003ccode\u003eUSER_DATA_BUCKET_LOCATION\u003c/code\u003e\nenvironment is set with the value from the \u003ccode\u003eConfigMap\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eUSER_DATA_BUCKET_LOCATION=http://doc-example-bucket.s3.amazonaws.com/\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a more comprehensive example of using \u003ccode\u003eFieldExport\u003c/code\u003e with multiple fields,\ncheck out the \u003ca href="../../tutorials/rds-example/"\u003eDeploy PostgreSQL + MariaDB Instances Using the ACK RDS\nController tutorial\u003c/a\u003e\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n \u003ccode\u003eFieldExport\u003c/code\u003e RBAC permissions\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThe ACK controller will fetch the source path from the ACK resource assuming\nits service account has the RBAC permissions to read that type of resource. If a\nuser has the privileges to create a \u003ccode\u003eFieldExport\u003c/code\u003e resource, it is possible that\nthey can create one which fetches fields from a resource they do not have RBAC\npermissions to read directly. This could potentially expose that resource\u0026rsquo;s\nproperties to the unprivileged user.\u003c/p\u003e\n\u003cp\u003eTo mitigate this problem, the ACK controller will only export fields from\nresources that exist in the same namespace as the \u003ccode\u003eFieldExport\u003c/code\u003e resource\nrequesting it.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n'}).add({id:39,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/adopted-resource/",title:"Adopting Existing AWS Resources",description:"Adopting Existing AWS Resources",content:'\u003cp\u003eThe ACK controllers are intended to manage the complete lifecycle of an AWS\nresource, from creation through deletion. However, you may already be\nmanaging those resources using other tools - such as CloudFormation or\nTerraform. Migrating to ACK could be time-consuming to redeclare all resources\nas YAML, or even cause you to lose the state of the application if parts of the\nsystem are recreated. The ACK \u003ccode\u003eAdoptedResource\u003c/code\u003e custom resource was designed to\nhelp migrate these AWS resources to be managed by an ACK controller in your Kubernetes\ncluster without having to define the full YAML spec or needing to delete and\nre-create the resource.\u003c/p\u003e\n\u003cp\u003eTo adopt an AWS resource, create an \u003ccode\u003eAdoptedResource\u003c/code\u003e custom\nresource that specifies the unique identifier for the AWS resource and a target\nK8s object. After applying this custom resource to the cluster, the ACK\ncontroller will describe the AWS resource and create the associated ACK resource\ninside the cluster - with a complete spec and status. The ACK controller will\nthen treat the newly-created ACK resource like any other.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers ship with the same \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD. Every controller\ncontains the logic for adopting resources from its particular service. That is,\nthe S3 controller understands how to adopt all S3 resources. If you don\u0026rsquo;t have a\nparticular service controller installed, and try to adopt a resource from that\nservice, the \u003ccode\u003eAdoptedResource\u003c/code\u003e CR will have no effect.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cp\u003eThe full spec for the \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD is located \u003ca href="https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/adoptedresource/"\u003ein the API\nreference\u003c/a\u003e. The spec contains two parts: the AWS resource reference and\nthe Kubernetes target.\u003c/p\u003e\n\u003ch3 id="aws-resource"\u003eAWS Resource\u003c/h3\u003e\n\u003cp\u003eThe AWS resource reference requires the unique identifier for the object, either\nas an ARN or as the name or ID of the object. Which of these is required depends\non the service and the particular resource.\nYou can find which field is required\nby finding the unique identifier field used by the \u003ccode\u003eDescribe*\u003c/code\u003e, \u003ccode\u003eList*\u003c/code\u003e, or \u003ccode\u003eGet*\u003c/code\u003e API\ncalls for that resource.\u003c/p\u003e\n\u003cp\u003eIf we were adopting for an IAM Role, since the \u003ca href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetRole.html"\u003eIAM Get Role API\u003c/a\u003e call requires \u003ccode\u003eRoleName\u003c/code\u003e, you should set \u003ccode\u003e.spec.aws.nameOrId\u003c/code\u003e to the name of the role you would like to adopt.\u003c/p\u003e\n\u003cp\u003eIf we were adopting for an IAM Policy, since the \u003ca href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html"\u003eIAM Get Policy API\u003c/a\u003e call requires \u003ccode\u003ePolicyArn\u003c/code\u003e, you should set \u003ccode\u003e.spec.aws.arn\u003c/code\u003e to the ARN of the policy you would like to adopt.\u003c/p\u003e\n\u003ch3 id="kubernetes-target"\u003eKubernetes Target\u003c/h3\u003e\n\u003cp\u003eThe Kubernetes target requires the \u003ccode\u003egroup\u003c/code\u003e and \u003ccode\u003ekind\u003c/code\u003e - these identify from\nwhich service and resource you wish to adopt. For example, to adopt an S3\nbucket, you would specify a \u003ccode\u003egroup\u003c/code\u003e of \u003ccode\u003es3.services.k8s.aws\u003c/code\u003e and a \u003ccode\u003ekind\u003c/code\u003e of\n\u003ccode\u003eBucket\u003c/code\u003e. The Kubernetes target also allows you to override the \u003ccode\u003emetadata\u003c/code\u003e for\nthe object that is created. By default, all resources created through an\n\u003ccode\u003eAdoptedResource\u003c/code\u003e will have the same \u003ccode\u003emetadata.name\u003c/code\u003e as the \u003ccode\u003eAdoptedResource\u003c/code\u003e\nthat created it.\u003c/p\u003e\n\u003ch3 id="example"\u003eExample\u003c/h3\u003e\n\u003cp\u003eBelow is an example of adopting an S3 bucket, overriding the name and namespace\nof the target K8s object and adding a label.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: services.k8s.aws/v1alpha1\nkind: AdoptedResource\nmetadata:\n name: adopt-my-existing-bucket\nspec: \n aws:\n nameOrID: example-bucket\n kubernetes:\n group: s3.services.k8s.aws\n kind: Bucket\n metadata:\n name: my-existing-bucket\n namespace: default\n labels:\n app: foo\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="additional-keys"\u003eAdditional Keys\u003c/h3\u003e\n\u003cp\u003eSome AWS resources cannot be defined using only a single unique identifier. For\nAPIs where we need to provide multiple identifiers, the \u003ccode\u003eAdoptedResource\u003c/code\u003e spec\ncontains a field called \u003ccode\u003eaws.additionalKeys\u003c/code\u003e which allows for any number of\narbitrary key-value pairs required to define the multiple identifier keys. When\nadopting a resource with multiple identifiers, provide the \u003cem\u003emost specific\u003c/em\u003e\nidentifier in the \u003ccode\u003enameOrID\u003c/code\u003e field. Then for each additional identifier, set the\nname of the key in \u003ccode\u003eadditionalKeys\u003c/code\u003e to be the name in the ACK spec or status for\nthat field, and the value to be the actual identifier value.\u003c/p\u003e\n\u003cp\u003eFor example, the \u003ca href="https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/integration/#spec"\u003e\u003ccode\u003eIntegration\u003c/code\u003e\u003c/a\u003e resource in AWS API Gateway\nV2 is uniquely identified by both an \u003ccode\u003eintegrationID\u003c/code\u003e and an \u003ccode\u003eapiID\u003c/code\u003e. The API\nrequires both of these features to \u003ca href="https://docs.aws.amazon.com/sdk-for-go/api/service/apigatewayv2/#GetIntegrationInput"\u003edescribe an integration\u003c/a\u003e. In\nthis case, we would provide the \u003ccode\u003eintegrationID\u003c/code\u003e for the \u003ccode\u003enameOrID\u003c/code\u003e field - since\nit is unique for every API Gateway v2 \u003ccode\u003eAPI\u003c/code\u003e object. Then to provide the \u003ccode\u003eapiID\u003c/code\u003e,\nwe add a key of \u003ccode\u003eapiID\u003c/code\u003e in the \u003ccode\u003eadditionalKeys\u003c/code\u003e and the value as the API ID for\nthe resource we want to adopt. The full spec of the \u003ccode\u003eAdoptedResource\u003c/code\u003e would look\nlike the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: services.k8s.aws/v1alpha1\nkind: AdoptedResource\nmetadata:\n name: adopt-my-existing-integration\nspec: \n aws:\n nameOrID: integration-id-123456789012\n additionalKeys:\n apiID: api-id-123456789012\n kubernetes:\n group: apigatewayv2.services.k8s.aws\n kind: Integration\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:40,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/ack-tags/",title:"Managing Tags on your AWS Resources",description:"Managing Tags on your AWS Resources",content:'\u003cp\u003eMost AWS resources can have one or more Tags, defined as simple key/value\npairs, associated with them. These Tags allow you to organize and categorize\nyour AWS resources for accounting and informational purposes. ACK custom\nresources (CRs) that support Tags will have a \u003cem\u003eSpec.Tags\u003c/em\u003e field that\nstores user-defined key/value pairs. In addition to user-defined Tags,\nACK also supports a set of default tags, which are Tags that the ACK\ncontroller will automatically ensure are on all resources that it manages.\u003c/p\u003e\n\u003cp\u003eThe two default tags added by ACK controller are \u003ccode\u003eservices.k8s.aws/controller-version\u003c/code\u003e\nand \u003ccode\u003eservices.k8s.aws/namespace\u003c/code\u003e. The \u003cem\u003econtroller-version\u003c/em\u003e tag value is the name of\ncorresponding AWS service and version for that controller(Ex: \u003ccode\u003es3-0.1.3\u003c/code\u003e).\nAnd the \u003cem\u003enamespace\u003c/em\u003e tag value is the Kubernetes namespace for the ACK\nresource.(Ex: \u003ccode\u003edefault\u003c/code\u003e)\u003c/p\u003e\n\u003cp\u003eWhen tags are already present inside the Kubernetes custom resource\u0026rsquo;s \u003ccode\u003eSpec.Tags\u003c/code\u003e,\nACK default tags are added to the AWS resource\u0026rsquo;s tags collection along with those\ntags from \u003ccode\u003eSpec.Tags\u003c/code\u003e. Priority is given to \u003ccode\u003eSpec.Tags\u003c/code\u003e when there is a\nconflict between ACK default tag keys and tag keys in \u003ccode\u003eSpec.Tags\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="example"\u003eExample\u003c/h2\u003e\n\u003cp\u003eFor a resource manifest like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: ecr.services.k8s.aws/v1alpha1\nkind: Repository\nmetadata:\n name: my-ack-tagging-repo\n namespace: default\nspec:\n name: my-ack-tagging-repo\n tags:\n - key: \u0026quot;first\u0026quot;\n value: \u0026quot;1\u0026quot;\n - key: \u0026quot;second\u0026quot;\n value: \u0026quot;2\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe sample response for \u003ccode\u003elist-tags-for-resource\u003c/code\u003e will look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr list-tags-for-resource --resource-arn arn:aws:ecr:us-west-2:************:repository/my-ack-tagging-repo\n{\n \u0026quot;tags\u0026quot;: [\n {\n \u0026quot;Key\u0026quot;: \u0026quot;services.k8s.aws/controller-version\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;ecr-0.1.4\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;first\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;1\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;services.k8s.aws/namespace\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;default\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;second\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;2\u0026quot;\n }\n ]\n}\n\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="configuring-default-tags"\u003eConfiguring Default Tags\u003c/h2\u003e\n\u003cp\u003eThe default tags added by ACK controllers are configurable during controller\ninstallation.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo remove the ACK default tags, set the \u003ccode\u003eresourceTags\u003c/code\u003e Helm value to be \u003ccode\u003e{}\u003c/code\u003e inside\n\u003cem\u003evalues.yaml\u003c/em\u003e file or use \u003ccode\u003e--set \'resourceTags={}\'\u003c/code\u003e during helm chart installation.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo override the default ACK tags, include each tag \u0026ldquo;key=value\u0026rdquo; pair as a list under\n\u003ccode\u003eresourceTags\u003c/code\u003e in \u003cem\u003evalues.yaml\u003c/em\u003e file\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresourceTags:\n- tk1=tv1\n- tk2=tv2\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can also override default ACK tags using \u003ccode\u003e--set \'resourceTags=[tk1=tv1, tk2=tv2]\'\u003c/code\u003e\nduring helm chart installation.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eACK supports variable expansion inside tag values for following variables:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e%CONTROLLER_SERVICE%\u003c/li\u003e\n\u003cli\u003e%CONTROLLER_VERSION%\u003c/li\u003e\n\u003cli\u003e%K8S_NAMESPACE%\u003c/li\u003e\n\u003cli\u003e%K8S_RESOURCE_NAME%\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eA custom resource tag \u003ccode\u003ek8s-name=%K8S_RESOURCE_NAME\u003c/code\u003e in above ecr repository example\nwould be expanded to \u0026ldquo;k8s-name=my-ack-tagging-repo\u0026rdquo;\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:41,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/release/",title:"Release",description:"The release process for ACK service controller",content:'\u003cp\u003eRemember that there is no single ACK binary. Rather, when we build a release\nfor ACK, that release is for one or more individual ACK service controllers\nbinaries, each of which are installed separately.\u003c/p\u003e\n\u003cp\u003eThis documentation covers the steps involved for officially publishing\na ACK service controller\u0026rsquo;s release artifacts.\u003c/p\u003e\n\u003cp\u003eOnce ACK service controller changes are tested by the service team and they wish to\nrelease latest artifacts, service team only needs to create a new release for service-controller\ngithub repository with a semver tag (Ex: \u003ccode\u003e0.0.1\u003c/code\u003e).\nSteps below show how to create a new release with semver tag.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Semver\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n For more details on semantic versioning(semver), please read our \u003ca href="../../community/releases/"\u003erelease phase guide\u003c/a\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eOnce the git repository is tagged with semver, a postsubmit prowjob builds\ncontainer image for ACK service controller and publish to public ecr repository \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/controller\u003c/code\u003e.\nSame prowjob also publishes the Helm charts for the ACK service controller to\npublic ecr repository \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/chart\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="what-is-a-release-exactly"\u003eWhat is a release exactly?\u003c/h2\u003e\n\u003cp\u003eA \u0026ldquo;release\u0026rdquo; is the combination of a Git tag containing a SemVer version tag\nagainst this source repository and the collection of \u003cem\u003eartifacts\u003c/em\u003e that allow the\nindividual ACK service controllers included in that Git commit to be easily\ninstalled via Helm.\u003c/p\u003e\n\u003cp\u003eThe Git tag points at a specific Git commit referencing the exact source code\nthat comprises the ACK service controllers in that \u0026ldquo;release\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eThe release artifacts include the following for one or more service\ncontrollers:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eContainer image\u003c/li\u003e\n\u003cli\u003eHelm chart\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe container image is built and pushed with an image tag that indicates the\nrelease version for the controller along with the AWS service. For example,\nassume a release semver tag of \u003ccode\u003e0.1.0\u003c/code\u003e that includes service controllers for\nS3 and SNS. There would be two container images built for this release, one each\ncontaining the ACK service controllers for S3 and SNS. The container images would\nhave the following image tags: \u003ccode\u003es3-0.1.0\u003c/code\u003e and \u003ccode\u003esns-0.1.0\u003c/code\u003e. Note\nthat the full image name would be\n\u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller:0.1.0\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eThe Helm chart artifact can be used to install the ACK service controller as a\nKubernetes Deployment; the Deployment\u0026rsquo;s Pod image will refer to the exact\ncontainer image tag matching the release tag.\u003c/p\u003e\n\u003ch2 id="release-steps"\u003eRelease steps\u003c/h2\u003e\n\u003col start="0"\u003e\n\u003cli\u003eRebase $SERVICE-controller repo with latest code:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd $GOSRC/github.com/aws-controllers-k8s\nexport SERVICE=s3\ncd $SERVICE-controller\ngit fetch --all --tags\n# Optionally fetch and rebase the latest code generator\ncd ../code-generator\ngit checkout main \u0026amp;\u0026amp; git fetch --all --tags \u0026amp;\u0026amp; git rebase upstream/main\n\u003c/code\u003e\u003c/pre\u003e\n\u003col\u003e\n\u003cli\u003eNavigate to $SERVICE-controller repo and check out a git branch for your release:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../$SERVICE-controller\nexport RELEASE_VERSION=v0.0.1\ngit checkout -b release-$RELEASE_VERSION\ngit branch --set-upstream-to=origin/main release-$RELEASE_VERSION\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="2"\u003e\n\u003cli\u003eNavigate to code-generator repo and build the release artifacts for the $SERVICE-controller:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../code-generator\nmake build-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="3"\u003e\n\u003cli\u003eNavigate to $SERVICE-controller repo to review the release artifacts that were built for each service by looking in the \u003ccode\u003ehelm\u003c/code\u003e\ndirectory:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../$SERVICE-controller\ngit diff\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When you run \u003ccode\u003emake build-controller\u003c/code\u003e for a service, it will overwrite any\nHelm chart files that had previously been generated in the \u003ccode\u003e$SERVICE-controller/helm\u003c/code\u003e\ndirectory with files that refer to the container image with an image tag\nreferring to the release you\u0026rsquo;ve just built artifacts for.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003col start="4"\u003e\n\u003cli\u003eCommit the generated release artifacts and create a pull request:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit commit -a -m \u0026quot;release artifacts for release $RELEASE_VERSION\u0026quot;\ngit push origin release-$RELEASE_VERSION\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="5"\u003e\n\u003cli\u003e\n\u003cp\u003eGet your pull request reviewed and merged. After merge, tag is automatically applied and pushed.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003ccode\u003egit tag\u003c/code\u003e operation (applied automatically in last step) triggers a postsubmit prowjob which builds container image and then publishes\nboth container image and Helm chart to public ECR repository.\nService team can see the release prowjobs, their status and logs at https://prow.ack.aws.dev/\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n'}).add({id:42,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/deletion-policy/",title:"Retain AWS Resources after CR Deletion",description:"Using the ACK deletion policy configuration",content:'\u003cp\u003eThe ACK controllers are designed to create, update and delete AWS resources\nfollowing the lifecycle of their respective Kubernetes custom resources. As a\nresult, when deleting an ACK resource, the underlying AWS resource is first\ndeleted before deleting its Kubernetes custom resource. This behavior is\nexpected so that users can delete AWS resources using the same Kubernetes APIs\nas they used to create them.\u003c/p\u003e\n\u003cp\u003eThere are some cases where a user wants to leave the underlying AWS resource\nintact, but still delete the resource from Kubernetes. For example, migrating\nstateful data resources (like S3 buckets or RDS database instances) between\nKubernetes installations or removing a resource from the control of an ACK\ncontroller without deleting the resource altogether.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers support \u0026ldquo;deletion policy\u0026rdquo; configuration, which lets the\ncontroller know which resources should be deleted from AWS (or left untouched)\nbefore deleting their K8s resources. The controller looks for deletion policy configuration\nin the following order:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eWithin an ACK resource annotation as \u003ccode\u003eservices.k8s.aws/deletion-policy\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eWithin a \u003ccode\u003eNamespace\u003c/code\u003e annotation as\n\u003ccode\u003e{service}.services.k8s.aws/deletion-policy\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eWithin the controller command-line using the \u003ccode\u003e--deletion-policy\u003c/code\u003e argument\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eEach of these configuration options supports the following values:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003edelete\u003c/code\u003e - \u003cstrong\u003e(Default)\u003c/strong\u003e Deletes the resource from AWS before deleting it from\nK8s\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eretain\u003c/code\u003e - Keeps the AWS resource intact before deleting it from K8s\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="configuring-the-deletion-policy"\u003eConfiguring the deletion policy\u003c/h2\u003e\n\u003ch3 id="using-helm-values"\u003eUsing Helm values\u003c/h3\u003e\n\u003cp\u003eTo set a controller-wide deletion policy, which will apply to all ACK resources\nowned by the ACK controller, you can set the \u003ccode\u003edeletionPolicy\u003c/code\u003e Helm chart value.\nThis Helm chart value accepts the same values as the deletion policy\nconfiguration described above.\u003c/p\u003e\n\u003cp\u003eFor example, to retain all AWS resources when installing the Helm chart through\nthe Helm CLI: \u003ccode\u003ehelm install ... --set=deletionPolicy=retain\u003c/code\u003e\u003c/p\u003e\n\u003ch3 id="for-all-resources-within-a-namespace"\u003eFor all resources within a Namespace\u003c/h3\u003e\n\u003cp\u003eTo set the deletion policy for all resources within a namespace (only for a\nsingle service), you can add an annotation to the \u003ccode\u003eNamespace\u003c/code\u003e object itself.\u003c/p\u003e\n\u003cp\u003eFor example, to set all S3 resources to be retained within the namespace:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Namespace\nmetadata:\n annotations:\n s3.services.k8s.aws/deletion-policy: retain\n name: retain-s3-namespace\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="for-a-single-ack-resource"\u003eFor a single ACK resource\u003c/h3\u003e\n\u003cp\u003eIf you want to just retain a single specific resource, you can override the\ndefault behavior by setting an annotation directly onto the resource.\u003c/p\u003e\n\u003cp\u003eFor example, to retain a specific S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: retained-bucket\n annotations:\n services.k8s.aws/deletion-policy: retain\nspec:\n name: my-retained-bucket\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003eNote: The key for annotating a single resource is not the same as the key when\nannotating a namespace. You do not need to provide the name of the service as a\nprefix for a single resource.\u003c/em\u003e\u003c/p\u003e\n'}).add({id:43,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/openshift/",title:"Red Hat OpenShift",description:"Configuration details specific to OpenShift clusters",content:'\u003cp\u003eConfiguration for ACK controllers in an OpenShift cluster.\u003c/p\u003e\n\u003ch2 id="pre-installation-instructions"\u003ePre-installation instructions\u003c/h2\u003e\n\u003cp\u003eWhen ACK service controllers are installed via OperatorHub, a cluster administrator will need to perform the following pre-installation steps to provide the controller any credentials and authentication context it needs to interact with the AWS API.\u003c/p\u003e\n\u003cp\u003eConfiguration and authentication in OpenShift requires the use of IAM users and policies. Authentication credentials are set inside a \u003ccode\u003eSecret\u003c/code\u003e (optional if utilizing \u003ca href="../irsa"\u003eIRSA\u003c/a\u003e) before installation of the controller.\u003c/p\u003e\n\u003ch3 id="step-1-create-the-installation-namespace"\u003eStep 1: Create the installation namespace\u003c/h3\u003e\n\u003cp\u003eIf the default \u003ccode\u003eack-system\u003c/code\u003e namespace does not exist already, create it:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc new-project ack-system\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-2-bind-an-aws-iam-principal-to-a-service-user-account"\u003eStep 2: Bind an AWS IAM principal to a service user account\u003c/h3\u003e\n\u003cp\u003eCreate a user with the \u003ccode\u003eaws\u003c/code\u003e CLI (named \u003ccode\u003eack-elasticache-service-controller\u003c/code\u003e in our example):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-user --user-name ack-elasticache-service-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eEnable programmatic access for the user you just created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-access-key --user-name ack-elasticache-service-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou should see output with important credentials:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e{\n \u0026quot;AccessKey\u0026quot;: {\n \u0026quot;UserName\u0026quot;: \u0026quot;ack-elasticache-service-controller\u0026quot;,\n \u0026quot;AccessKeyId\u0026quot;: \u0026quot;00000000000000000000\u0026quot;,\n \u0026quot;Status\u0026quot;: \u0026quot;Active\u0026quot;,\n \u0026quot;SecretAccessKey\u0026quot;: \u0026quot;abcdefghIJKLMNOPQRSTUVWXYZabcefghijklMNO\u0026quot;,\n \u0026quot;CreateDate\u0026quot;: \u0026quot;2021-09-30T19:54:38+00:00\u0026quot;\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSave or note \u003ccode\u003eAccessKeyId\u003c/code\u003e and \u003ccode\u003eSecretAccessKey\u003c/code\u003e for later use.\u003c/p\u003e\n\u003cp\u003eEach service controller repository provides a recommended policy ARN for use with the controller. For an example, see the recommended policy for \u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller/blob/main/config/iam/recommended-policy-arn"\u003eElasticache here\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eAttach the recommended policy to the user we created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam attach-user-policy \\\n --user-name ack-elasticache-service-controller \\\n --policy-arn \'arn:aws:iam::aws:policy/AmazonElastiCacheFullAccess\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-3-create-ack-service-user-config-and-ack-service-user-secrets-for-authentication"\u003eStep 3: Create \u003ccode\u003eack-$SERVICE-user-config\u003c/code\u003e and \u003ccode\u003eack-$SERVICE-user-secrets\u003c/code\u003e for authentication\u003c/h3\u003e\n\u003cp\u003eEnter the \u003ccode\u003eack-system\u003c/code\u003e namespace. Create a file, \u003ccode\u003econfig.txt\u003c/code\u003e, with the following variables, leaving \u003ccode\u003eACK_WATCH_NAMESPACE\u003c/code\u003e blank so the controller can properly watch all namespaces, and change any other values to suit your needs:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eACK_ENABLE_DEVELOPMENT_LOGGING=true\nACK_LOG_LEVEL=debug\nACK_WATCH_NAMESPACE=\nAWS_REGION=us-west-2\nAWS_ENDPOINT_URL=\nACK_RESOURCE_TAGS=hellofromocp\nENABLE_LEADER_ELECTION=true\nLEADER_ELECTION_NAMESPACE=\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow use \u003ccode\u003econfig.txt\u003c/code\u003e to create a \u003ccode\u003eConfigMap\u003c/code\u003e in your OpenShift cluster:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=elasticache\n\noc create configmap \\\n--namespace ack-system \\\n--from-env-file=config.txt ack-$SERVICE-user-config\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThe \u003ccode\u003eSecret\u003c/code\u003e is optional if \u003ca href="../irsa"\u003eIRSA\u003c/a\u003e is intended to be used. In order to utilize IRSA, STS would have needed to be configured during cluster installation.\nThere are two ways to provision an OpenShift cluster to utilize STS:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="https://docs.openshift.com/container-platform/latest/authentication/managing_cloud_provider_credentials/cco-mode-sts.html"\u003eOpenShift Container Platform using manual mode for STS\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.openshift.com/rosa/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.html"\u003eRed Hat OpenShift Service on AWS\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eSave another file, \u003ccode\u003esecrets.txt\u003c/code\u003e, with the following authentication values, which you should have saved from earlier when you created your user\u0026rsquo;s access keys:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ACCESS_KEY_ID=00000000000000000000\nAWS_SECRET_ACCESS_KEY=abcdefghIJKLMNOPQRSTUVWXYZabcefghijklMNO\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUse \u003ccode\u003esecrets.txt\u003c/code\u003e to create a \u003ccode\u003eSecret\u003c/code\u003e in your OpenShift cluster:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc create secret generic \\\n--namespace ack-system \\\n--from-env-file=secrets.txt ack-$SERVICE-user-secrets\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDelete \u003ccode\u003econfig.txt\u003c/code\u003e and \u003ccode\u003esecrets.txt\u003c/code\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Warning\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you change the name of either the \u003ccode\u003eConfigMap\u003c/code\u003e or the \u003ccode\u003eSecret\u003c/code\u003e from the values given above, i.e. \u003ccode\u003eack-$SERVICE-user-config\u003c/code\u003e and \u003ccode\u003eack-$SERVICE-user-secrets\u003c/code\u003e, then installations from OperatorHub will not function properly. The Deployment for the controller is preconfigured for these key values.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="step-4-optional-apply-additional-custom-resource-definitionscrd"\u003eStep 4 (Optional): Apply Additional Custom Resource Definitions(CRD)\u003c/h3\u003e\n\u003cp\u003eTo prevent CRD installation conflicts for CRDs shared across multiple AWS Controllers for Kubernetes,\nthe \u003ca href="../../../reference/common/v1alpha1/adoptedresource/"\u003eAdoptedResource\u003c/a\u003e and \u003ca href="../../../reference/common/v1alpha1/fieldexport/"\u003eFieldExport\u003c/a\u003e CRDs are not included in the OpenShift Embedded OperatorHub.\nThese must be installed manually by a cluster administrator before any controller is installed by running the following commands:\u003c/p\u003e\n\u003cp\u003eApply the \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc apply -f https://raw.githubusercontent.com/aws-controllers-k8s/runtime/main/config/crd/bases/services.k8s.aws_adoptedresources.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply the \u003ccode\u003eFieldExport\u003c/code\u003e CRD\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc apply -f https://raw.githubusercontent.com/aws-controllers-k8s/runtime/main/config/crd/bases/services.k8s.aws_fieldexports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-5-install-the-controller"\u003eStep 5: Install the controller\u003c/h3\u003e\n\u003cp\u003eFollow the instructions for \u003ca href="../install/#install-an-ack-service-controller-with-operatorhub-in-red-hat-openshift"\u003einstalling the controller using OperatorHub\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="additional-uninstallation-steps"\u003eAdditional uninstallation steps\u003c/h2\u003e\n\u003cp\u003ePerform the following cleanup steps in addition to the steps in \u003ca href="../cleanup"\u003eUninstall an ACK Controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="uninstall-the-ack-controller"\u003eUninstall the ACK Controller\u003c/h3\u003e\n\u003cp\u003eNavigate in the OpenShift dashboard to the OperatorHub page and search for the controller name. Select \u003cstrong\u003eUninstall\u003c/strong\u003e to remove the controller.\u003c/p\u003e\n\u003ch3 id="delete-configmap"\u003eDelete ConfigMap\u003c/h3\u003e\n\u003cp\u003eDelete the following \u003ccode\u003eConfigMap\u003c/code\u003e you created in pre-installation:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc delete configmap ack-$SERVICE-user-config\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="delete-user-secret"\u003eDelete user Secret\u003c/h3\u003e\n\u003cp\u003eDelete the folllowing \u003ccode\u003eSecret\u003c/code\u003e you created in pre-installation:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc delete secret ack-$SERVICE-user-secrets\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eAfter you install the controller, you can follow the \u003ca href="../cross-account-resource-management"\u003eCross Account Resource Management\u003c/a\u003e instructions to manage resources in multiple AWS accounts.\u003c/p\u003e\n'}).add({id:44,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/",title:"Uninstall an ACK Controller",description:"Uninstall an ACK Controller",content:'\u003cp\u003eUse the \u003ccode\u003ehelm uninstall\u003c/code\u003e command to uninstall an ACK service controller:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\n\n# Uninstall the ACK service controller with Helm\nhelm uninstall -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-crds"\u003eDelete CRDs\u003c/h2\u003e\n\u003ch3 id="delete-individual-crds"\u003eDelete individual CRDS\u003c/h3\u003e\n\u003cp\u003eIf you have multiple controllers installed and only want to delete CRDs related to a specific resource, use the \u003ccode\u003ekubectl delete\u003c/code\u003e command to delete the CRDs with the the service name prefix.\u003c/p\u003e\n\u003cp\u003eFor example, use the following commands to delete the CRD for Amazon S3 Buckets:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport CHART_EXPORT_PATH=/tmp/chart\n\n# Delete an individual CRD\nkubectl delete -f $CHART_EXPORT_PATH/$SERVICE-chart/crds/s3.services.k8s.aws_buckets.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Check for CRDs that are common across services\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n There are a few custom resource definitions (CRDs) that are common across services. If you have multiple controllers installed, you should not delete the common CRDs unless you are uninstalling all of the controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="delete-all-crds"\u003eDelete all CRDs\u003c/h3\u003e\n\u003cp\u003eIf you are sure that you would like to delete all CRDs, use the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport CHART_EXPORT_PATH=/tmp/chart\n\n# Delete all CRDs\nkubectl delete -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="verify-helm-charts-were-deleted"\u003eVerify Helm charts were deleted\u003c/h2\u003e\n\u003cp\u003eVerify that the Helm chart for your ACK service controller was deleted with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm ls -n $ACK_SYSTEM_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-namespaces"\u003eDelete namespaces\u003c/h2\u003e\n\u003cp\u003eDelete a specified namespace with the \u003ccode\u003ekubectl delete namespace\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete namespace $ACK_SYSTEM_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-configmap"\u003eDelete ConfigMap\u003c/h2\u003e\n\u003cp\u003eIf you used \u003ca href="../cross-account-resource-management/"\u003ecross account resource management\u003c/a\u003e, delete the \u003ccode\u003eConfigMap\u003c/code\u003e you created.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -n ack-system configmap ack-role-account-map\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:45,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/accessentry/",title:"AccessEntry",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#AccessEntry"\u003eeks-controller/apis/v1alpha1#AccessEntry\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessEntry\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessEntryList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccessentries\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccessentry\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn access entry allows an IAM principal (user or role) to access your cluster.\nAccess entries can replace the need to maintain the aws-auth ConfigMap for\nauthentication. For more information about access entries, see Access entries\n(https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) in\nthe Amazon EKS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPolicies:\n accessScope: \n namespaces:\n - string\n type: string\n policyARN: string\nclusterName: string\nclusterRef: \n from: \n name: string\nkubernetesGroups:\n- string\nprincipalARN: string\ntags: {}\ntype: string\nusername: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].accessScope.namespaces\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].accessScope.namespaces.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].policyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe value for name that you\u0026rsquo;ve specified for kind: Group as a subject in\u003cbr/\u003ea Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn\u0026rsquo;t\u003cbr/\u003econfirm that the value for name exists in any bindings on your cluster. You\u003cbr/\u003ecan specify one or more names.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKubernetes authorizes the principalArn of the access entry to access any\u003cbr/\u003ecluster objects that you\u0026rsquo;ve specified in a Kubernetes Role or ClusterRole\u003cbr/\u003eobject that is also specified in a binding\u0026rsquo;s roleRef. For more information\u003cbr/\u003eabout creating Kubernetes RoleBinding, ClusterRoleBinding, Role, or ClusterRole\u003cbr/\u003eobjects, see Using RBAC Authorization in the Kubernetes documentation (https://kubernetes.io/docs/reference/access-authn-authz/rbac/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want Amazon EKS to authorize the principalArn (instead of, or in addition\u003cbr/\u003eto Kubernetes authorizing the principalArn), you can associate one or more\u003cbr/\u003eaccess policies to the access entry using AssociateAccessPolicy. If you associate\u003cbr/\u003eany access policies, the principalARN has all permissions assigned in the\u003cbr/\u003eassociated access policies and all permissions in any Kubernetes Role or\u003cbr/\u003eClusterRole objects that the group names are bound to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etype\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of the new access entry. Valid values are Standard, FARGATE_LINUX,\u003cbr/\u003eEC2_LINUX, and EC2_WINDOWS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the principalArn is for an IAM role that\u0026rsquo;s used for self-managed Amazon\u003cbr/\u003eEC2 nodes, specify EC2_LINUX or EC2_WINDOWS. Amazon EKS grants the necessary\u003cbr/\u003epermissions to the node for you. If the principalArn is for any other purpose,\u003cbr/\u003especify STANDARD. If you don\u0026rsquo;t specify a value, Amazon EKS sets the value\u003cbr/\u003eto STANDARD. It\u0026rsquo;s unnecessary to create access entries for IAM roles used\u003cbr/\u003ewith Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates\u003cbr/\u003eentries in the aws-auth ConfigMap for the roles. You can\u0026rsquo;t change this value\u003cbr/\u003eonce you\u0026rsquo;ve created the access entry.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you set the value to EC2_LINUX or EC2_WINDOWS, you can\u0026rsquo;t specify values\u003cbr/\u003efor kubernetesGroups, or associate an AccessPolicy to the access entry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username to authenticate to Kubernetes with. We recommend not specifying\u003cbr/\u003ea username and letting Amazon EKS specify it for you. For more information\u003cbr/\u003eabout the value Amazon EKS specifies for you, or constraints before specifying\u003cbr/\u003eyour own username, see Creating access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nmodifiedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp for the last modification to the object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:46,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/accesspoint/",title:"AccessPoint",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#AccessPoint"\u003eefs-controller/apis/v1alpha1#AccessPoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessPoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessPointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccesspoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccesspoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efileSystemID: string\nfileSystemRef: \n from: \n name: string\nposixUser: \n gid: integer\n secondaryGIDs:\n - integer\n uid: integer\nrootDirectory: \n creationInfo: \n ownerGID: integer\n ownerUID: integer\n permissions: string\n path: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the EFS file system that the access point provides access to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe operating system user and group applied to all file system requests made\u003cbr/\u003eusing the access point.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.gid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.secondaryGIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.secondaryGIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the directory on the EFS file system that the access point exposes\u003cbr/\u003eas the root directory of your file system to NFS clients using the access\u003cbr/\u003epoint. The clients using the access point can only access the root directory\u003cbr/\u003eand below. If the RootDirectory \u0026gt; Path specified does not exist, Amazon EFS\u003cbr/\u003ecreates it and applies the CreationInfo settings when a client connects to\u003cbr/\u003ean access point. When specifying a RootDirectory, you must provide the Path,\u003cbr/\u003eand the CreationInfo.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon EFS creates a root directory only if you have provided the CreationInfo:\u003cbr/\u003eOwnUid, OwnGID, and permissions for the directory. If you do not provide\u003cbr/\u003ethis information, Amazon EFS does not create the root directory. If the root\u003cbr/\u003edirectory does not exist, attempts to mount using the access point will fail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRequired if the RootDirectory \u0026gt; Path specified does not exist. Specifies\u003cbr/\u003ethe POSIX IDs and permissions to apply to the access point\u0026rsquo;s RootDirectory\u003cbr/\u003e\u0026gt; Path. If the access point root directory does not exist, EFS creates it\u003cbr/\u003ewith these settings when a client connects to the access point. When specifying\u003cbr/\u003eCreationInfo, you must include values for all properties.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon EFS creates a root directory only if you have provided the CreationInfo:\u003cbr/\u003eOwnUid, OwnGID, and permissions for the directory. If you do not provide\u003cbr/\u003ethis information, Amazon EFS does not create the root directory. If the root\u003cbr/\u003edirectory does not exist, attempts to mount using the access point will fail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not provide CreationInfo and the specified RootDirectory does not\u003cbr/\u003eexist, attempts to mount the file system using the access point will fail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.ownerGID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.ownerUID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.permissions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.path\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eCreates tags associated with the access point. Each tag is a key-value pair,\u003cbr/\u003eeach key must be unique. For more information, see Tagging Amazon Web Services\u003cbr/\u003eresources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag is a key-value pair. Allowed characters are letters, white space, and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003enumbers that can be represented in UTF-8, and the following characters:+\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cul\u003e\n\u003cli\u003e= . _ : /. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPointID: string\nackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlifeCycleState: string\nname: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the access point, assigned by Amazon EFS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the lifecycle phase of the access point.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the access point. This is the value of the Name tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the Amazon Web Services account that owns the access point resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:47,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/acl/",title:"ACL",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#ACL"\u003ememorydb-controller/apis/v1alpha1#ACL\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eACL\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eACLList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eacls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eacl\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntags:\n- key: string\n value: string\nuserNames:\n- string\nuserRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Access Control List.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of users that belong to the Access Control List.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusters:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nminimumEngineVersion: string\npendingChanges: \n userNamesToAdd:\n - string\n userNamesToRemove:\n - string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of clusters associated with the ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version supported for the ACL\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of updates being applied to the ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:48,href:"https://aws-controllers-k8s.github.io/community/reference/sfn/v1alpha1/activity/",title:"Activity",description:null,content:'\u003cp\u003e\u003ccode\u003esfn.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sfn-controller/apis/v1alpha1#Activity"\u003esfn-controller/apis/v1alpha1#Activity\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eActivity\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eActivityList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eactivities\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eactivity\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the activity to create. This name must be unique for your AWS\u003cbr/\u003eaccount and region for 90 days. For more information, see Limits Related\u003cbr/\u003eto State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions)\u003cbr/\u003ein the AWS Step Functions Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA name must not contain:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * white space\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * brackets \u0026lt; \u0026gt; { } [ ]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wildcard characters ? *\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * special characters \u0026quot; # % \\ ^\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of tags to add to a resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\u003cbr/\u003eTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\u003cbr/\u003ein the AWS Billing and Cost Management User Guide, and Controlling Access\u003cbr/\u003eUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\u003cbr/\u003e_ . : / = + - @.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are key-value pairs that can be associated with Step Functions state\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emachines and activities.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\nTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\nin the AWS Billing and Cost Management User Guide, and Controlling Access\nUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/p\u003e\n\u003cp\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\n_ . : / = + - @. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the activity is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:49,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/addon/",title:"Addon",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Addon"\u003eeks-controller/apis/v1alpha1#Addon\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAddon\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAddonList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaddons\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaddon\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html)\nin the Amazon EKS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaddonVersion: string\nclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nconfigurationValues: string\nname: string\nresolveConflicts: string\nserviceAccountRoleARN: string\nserviceAccountRoleRef: \n from: \n name: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaddonVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the add-on. The version must match one of the versions returned\u003cbr/\u003eby DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe set of configuration values for the add-on that\u0026rsquo;s created. The values\u003cbr/\u003ethat you provide are validated against the schema returned by DescribeAddonConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the add-on. The name must match one of the names returned by\u003cbr/\u003eDescribeAddonVersions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolveConflicts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eHow to resolve field value conflicts for an Amazon EKS add-on. Conflicts\u003cbr/\u003eare handled based on the value you choose:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * None – If the self-managed version of the add-on is installed on your\u003cbr/\u003e cluster, Amazon EKS doesn\u0026rsquo;t change the value. Creation of the add-on might\u003cbr/\u003e fail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Overwrite – If the self-managed version of the add-on is installed\u003cbr/\u003e on your cluster and the Amazon EKS default value is different than the\u003cbr/\u003e existing value, Amazon EKS changes the value to the Amazon EKS default\u003cbr/\u003e value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Preserve – This is similar to the NONE option. If the self-managed\u003cbr/\u003e version of the add-on is installed on your cluster Amazon EKS doesn\u0026rsquo;t\u003cbr/\u003e change the add-on resource properties. Creation of the add-on might fail\u003cbr/\u003e if conflicts are detected. This option works differently during the update\u003cbr/\u003e operation. For more information, see UpdateAddon (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t currently have the self-managed version of the add-on installed\u003cbr/\u003eon your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all\u003cbr/\u003evalues to default values, regardless of the option that you specify.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on\u0026rsquo;s\u003cbr/\u003eservice account. The role must be assigned the IAM permissions required by\u003cbr/\u003ethe add-on. If you don\u0026rsquo;t specify an existing IAM role, then the add-on uses\u003cbr/\u003ethe permissions assigned to the node IAM role. For more information, see\u003cbr/\u003eAmazon EKS node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC)\u003cbr/\u003eprovider created for your cluster. For more information, see Enabling IAM\u003cbr/\u003eroles for service accounts on your cluster (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nmarketplaceInformation: \n productID: string\n productURL: string\nmodifiedAt: string\nowner: string\npublisher: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the health of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn issue related to an add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emarketplaceInformation.productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emarketplaceInformation.productURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp for the last modification to the object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe owner of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublisher\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe publisher of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:50,href:"https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/adoptedresource/",title:"AdoptedResource",description:null,content:'\u003cp\u003e\u003ccode\u003eservices.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1#AdoptedResource"\u003eruntime/apis/core/v1alpha1#AdoptedResource\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAdoptedResource\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAdoptedResourceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eadoptedresources\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eadoptedresource\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaws: \n additionalKeys: {}\n arn: string\n nameOrID: string\nkubernetes: \n group: string\n kind: string\n metadata: \n annotations: {}\n generateName: string\n labels: {}\n name: string\n namespace: string\n ownerReferences:\n - apiVersion: string\n blockOwnerDeletion: boolean\n controller: boolean\n kind: string\n name: string\n uid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSIdentifiers provide all unique ways to reference an AWS resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.additionalKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditionalKeys represents any additional arbitrary identifiers used when\u003cbr/\u003edescribing the target resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the AWS Resource Name for the resource. It is a globally\u003cbr/\u003eunique identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.nameOrID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNameOrId is a user-supplied string identifier for the resource. It may\u003cbr/\u003eor may not be globally unique, depending on the type of resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eResourceWithMetadata provides the values necessary to create a\u003cbr/\u003eKubernetes resource and override any of its metadata values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.group\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eObjectMeta is metadata that all persisted resources must have, which includes all objects\u003cbr/\u003eusers must create.\u003cbr/\u003eIt is not possible to use \u003ccode\u003emetav1.ObjectMeta\u003c/code\u003e inside spec, as the controller-gen\u003cbr/\u003eautomatically converts this to an arbitrary string-string map.\u003cbr/\u003ehttps://github.com/kubernetes-sigs/controller-tools/issues/385\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eActive discussion about inclusion of this field in the spec is happening in this PR:\u003cbr/\u003ehttps://github.com/kubernetes-sigs/controller-tools/pull/395\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUntil this is allowed, or if it never is, we will produce a subset of the object meta\u003cbr/\u003ethat contains only the fields which the user is allowed to modify in the metadata.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.annotations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAnnotations is an unstructured key value map stored with a resource that may be\u003cbr/\u003eset by external tools to store and retrieve arbitrary metadata. They are not\u003cbr/\u003equeryable and should be preserved when modifying objects.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/annotations\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.generateName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eGenerateName is an optional prefix, used by the server, to generate a unique\u003cbr/\u003ename ONLY IF the Name field has not been provided.\u003cbr/\u003eIf this field is used, the name returned to the client will be different\u003cbr/\u003ethan the name passed. This value will also be combined with a unique suffix.\u003cbr/\u003eThe provided value has the same validation rules as the Name field,\u003cbr/\u003eand may be truncated by the length of the suffix required to make the value\u003cbr/\u003eunique on the server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf this field is specified and the generated name exists, the server will\u003cbr/\u003eNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\u003cbr/\u003eServerTimeout indicating a unique name could not be found in the time allotted, and the client\u003cbr/\u003eshould retry (optionally after the time indicated in the Retry-After header).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eApplied only if Name is not specified.\u003cbr/\u003eMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.labels\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap of string keys and values that can be used to organize and categorize\u003cbr/\u003e(scope and select) objects. May match selectors of replication controllers\u003cbr/\u003eand services.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/labels\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eName must be unique within a namespace. Is required when creating resources, although\u003cbr/\u003esome resources may allow a client to request the generation of an appropriate name\u003cbr/\u003eautomatically. Name is primarily intended for creation idempotence and configuration\u003cbr/\u003edefinition.\u003cbr/\u003eCannot be updated.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/identifiers#names\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNamespace defines the space within each name must be unique. An empty namespace is\u003cbr/\u003eequivalent to the \u0026ldquo;default\u0026rdquo; namespace, but \u0026ldquo;default\u0026rdquo; is the canonical representation.\u003cbr/\u003eNot all objects are required to be scoped to a namespace - the value of this field for\u003cbr/\u003ethose objects will be empty.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMust be a DNS_LABEL.\u003cbr/\u003eCannot be updated.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/namespaces\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of objects depended by this object. If ALL objects in the list have\u003cbr/\u003ebeen deleted, this object will be garbage collected. If this object is managed by a controller,\u003cbr/\u003ethen an entry in this list will point to this controller, with the controller field set to true.\u003cbr/\u003eThere cannot be more than one managing controller.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOwnerReference contains enough information to let you identify an owning\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eobject. An owning object must be in the same namespace as the dependent, or\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ebe cluster-scoped, so there is no namespace field.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].blockOwnerDeletion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf true, AND if the owner has the \u0026ldquo;foregroundDeletion\u0026rdquo; finalizer, then\u003cbr/\u003ethe owner cannot be deleted from the key-value store until this\u003cbr/\u003ereference is removed.\u003cbr/\u003eSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\u003cbr/\u003efor how the garbage collector interacts with this field and enforces the foreground deletion.\u003cbr/\u003eDefaults to false.\u003cbr/\u003eTo set this field, a user needs \u0026ldquo;delete\u0026rdquo; permission of the owner,\u003cbr/\u003eotherwise 422 (Unprocessable Entity) will be returned.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].controller\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf true, this reference points to the managing controller.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].kind\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKind of the referent.\u003cbr/\u003eMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eName of the referent.\u003cbr/\u003eMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].uid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUID of the referent.\u003cbr/\u003eMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various\u003cbr/\u003eterminal states of the adopted resource CR and its target custom resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:51,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/alertmanagerdefinition/",title:"AlertManagerDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#AlertManagerDefinition"\u003eprometheusservice-controller/apis/v1alpha1#AlertManagerDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlertManagerDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlertManagerDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealertmanagerdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealertmanagerdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfiguration: string\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace in which to create the alert manager definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatusCode: string\nstatusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus code of this definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for failure if any.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:52,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/alias/",title:"Alias",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Alias"\u003ekms-controller/apis/v1alpha1#Alias\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAliasList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealiases\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntargetKeyID: string\ntargetKeyRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the alias name. This value must begin with alias/ followed by a\u003cbr/\u003ename, such as alias/ExampleAlias.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe AliasName value must be string of 1-256 characters. It can contain only\u003cbr/\u003ealphanumeric characters, forward slashes (/), underscores (_), and dashes\u003cbr/\u003e(-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is\u003cbr/\u003ereserved for Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAssociates the alias with the specified customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk).\u003cbr/\u003eThe KMS key must be in the same Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA valid key ID is required. If you supply a null or empty string value, this\u003cbr/\u003eoperation returns an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the key ID or key ARN of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:53,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/alias/",title:"Alias",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Alias"\u003elambda-controller/apis/v1alpha1#Alias\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAliasList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealiases\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nfunctionVersion: string\nname: string\nprovisionedConcurrencyConfig: \n functionName: string\n provisionedConcurrentExecutions: integer\n qualifier: string\nroutingConfig: \n additionalVersionWeights: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures options for asynchronous invocation on an alias.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- DestinationConfig\u003cbr/\u003eA destination for events after they have been sent to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypes of Destinations:\u003cbr/\u003eFunction - The Amazon Resource Name (ARN) of a Lambda function.\u003cbr/\u003eQueue - The ARN of a standard SQS queue.\u003cbr/\u003eTopic - The ARN of a standard SNS topic.\u003cbr/\u003eEvent Bus - The ARN of an Amazon EventBridge event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumEventAgeInSeconds\u003cbr/\u003eThe maximum age of a request that Lambda sends to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumRetryAttempts\u003cbr/\u003eThe maximum number of times to retry when the function returns an error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name - MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN - 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function version that the alias invokes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures provisioned concurrency to a function\u0026rsquo;s alias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- ProvisionedConcurrentExecutions\u003cbr/\u003eThe amount of provisioned concurrency to allocate for the version or alias.\u003cbr/\u003eMinimum value of 1 is required\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.provisionedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing)\u003cbr/\u003eof the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.additionalVersionWeights\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nrevisionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique identifier that changes when you update the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:54,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/api/",title:"API",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#API"\u003eapigatewayv2-controller/apis/v1alpha1#API\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAPI\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAPIList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapis\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapi\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an API.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiKeySelectionExpression: string\nbasepath: string\nbody: string\ncorsConfiguration: \n allowCredentials: boolean\n allowHeaders:\n - string\n allowMethods:\n - string\n allowOrigins:\n - string\n exposeHeaders:\n - string\n maxAge: integer\ncredentialsARN: string\ndescription: string\ndisableExecuteAPIEndpoint: boolean\ndisableSchemaValidation: boolean\nfailOnWarnings: boolean\nname: string\nprotocolType: string\nrouteKey: string\nrouteSelectionExpression: string\ntags: {}\ntarget: string\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiKeySelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebasepath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebody\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CORS configuration. Supported only for HTTP APIs. See Configuring\u003cbr/\u003eCORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of allowed headers. Supported only for HTTP APIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableExecuteAPIEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableSchemaValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailOnWarnings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprotocolType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiEndpoint: string\napiGatewayManaged: boolean\napiID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nimportInfo:\n- string\nwarnings:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportInfo.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarnings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:55,href:"https://aws-controllers-k8s.github.io/community/reference/",title:"API Reference",description:null,content:""}).add({id:56,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/app/",title:"App",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#App"\u003esagemaker-controller/apis/v1alpha1#App\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eApp\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAppList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapps\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapp\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappName: string\nappType: string\ndomainID: string\nresourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\ntags:\n- key: string\n value: string\nuserProfileName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the app.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of app.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe instance type and the Amazon Resource Name (ARN) of the SageMaker image\u003cbr/\u003ecreated on the instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value of InstanceType passed as part of the ResourceSpec in the CreateApp\u003cbr/\u003ecall overrides the value passed as part of the ResourceSpec configured for\u003cbr/\u003ethe user profile or the domain. If InstanceType is not specified in any of\u003cbr/\u003ethose three ResourceSpec values for a KernelGateway app, the CreateApp call\u003cbr/\u003efails with a request validation error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEach tag consists of a key and an optional value. Tag keys must be unique\u003cbr/\u003eper resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserProfileName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe user profile name. If this value is not set, then SpaceName must be set. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:57,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/archive/",title:"Archive",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Archive"\u003eeventbridge-controller/apis/v1alpha1#Archive\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eArchive\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eArchiveList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003earchives\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003earchive\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Archive object that contains details about an archive.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventPattern: string\neventSourceARN: string\neventSourceRef: \n from: \n name: string\nname: string\nretentionDays: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventPattern\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn event pattern to use to filter events sent to the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the event bus that sends events to the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the archive to create.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain events for. Default value is 0. If set to 0,\u003cbr/\u003eevents are retained indefinitely\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nstate: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the archive was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the archive that was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason that the archive is in the state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:58,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/authorizer/",title:"Authorizer",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Authorizer"\u003eapigatewayv2-controller/apis/v1alpha1#Authorizer\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAuthorizer\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAuthorizerList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eauthorizers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eauthorizer\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an authorizer.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\nauthorizerCredentialsARN: string\nauthorizerPayloadFormatVersion: string\nauthorizerResultTTLInSeconds: integer\nauthorizerType: string\nauthorizerURI: string\nenableSimpleResponses: boolean\nidentitySource:\n- string\nidentityValidationExpression: string\njwtConfiguration: \n audience:\n - string\n issuer: string\nname: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerCredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerPayloadFormatVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerResultTTLInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableSimpleResponses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentitySource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentitySource.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the configuration of a JWT authorizer. Required for the JWT authorizer\u003cbr/\u003etype. Supported only for HTTP APIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration.audience\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration.audience.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nauthorizerID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:59,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/backup/",title:"Backup",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#Backup"\u003edynamodb-controller/apis/v1alpha1#Backup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBackup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBackupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebackups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebackup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebackupName: string\ntableName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecified name for the backup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbackupCreationDateTime: string\nbackupExpiryDateTime: string\nbackupSizeBytes: integer\nbackupStatus: string\nbackupType: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupCreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTime at which the backup was created. This is the request time of the backup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupExpiryDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTime at which the automatic on-demand backup created by DynamoDB will expire.\u003cbr/\u003eThis SYSTEM on-demand backup expires automatically 35 days after its creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSize of the backup in bytes. DynamoDB updates this value approximately every\u003cbr/\u003esix hours. Recent changes might not be reflected in this value.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eBackup can be in one of the following states: CREATING, ACTIVE, DELETED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eBackupType:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * USER - You create and manage these using the on-demand backup feature.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SYSTEM - If you delete a table with point-in-time recovery enabled,\u003cbr/\u003e a SYSTEM backup is automatically created and is retained for 35 days (at\u003cbr/\u003e no additional cost). System backups allow you to restore the deleted table\u003cbr/\u003e to the state it was in just before the point of deletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AWS_BACKUP - On-demand backup created by you from Backup service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:60,href:"https://aws-controllers-k8s.github.io/community/reference/mq/v1alpha1/broker/",title:"Broker",description:null,content:'\u003cp\u003e\u003ccode\u003emq.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/mq-controller/apis/v1alpha1#Broker"\u003emq-controller/apis/v1alpha1#Broker\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBroker\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBrokerList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebrokers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebroker\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauthenticationStrategy: string\nautoMinorVersionUpgrade: boolean\nconfiguration: \n id: string\n revision: integer\ncreatorRequestID: string\ndeploymentMode: string\nencryptionOptions: \n kmsKeyID: string\n useAWSOwnedKey: boolean\nengineType: string\nengineVersion: string\nhostInstanceType: string\nldapServerMetadata: \n hosts:\n - string\n roleBase: string\n roleName: string\n roleSearchMatching: string\n roleSearchSubtree: boolean\n serviceAccountPassword: string\n serviceAccountUsername: string\n userBase: string\n userRoleName: string\n userSearchMatching: string\n userSearchSubtree: boolean\nlogs: \n audit: boolean\n general: boolean\nmaintenanceWindowStartTime: \n dayOfWeek: string\n timeOfDay: string\n timeZone: string\nname: string\npubliclyAccessible: boolean\nsecurityGroupRefs:\n from: \n name: string\nsecurityGroups:\n- string\nstorageType: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags: {}\nusers:\n- consoleAccess: boolean\n groups:\n - string\n password: \n key: string\n name: string\n namespace: string\n username: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of information about the configuration.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.revision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEncryption options for the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions.useAWSOwnedKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostInstanceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional. The metadata of the LDAP server used to authenticate and authorize\u003cbr/\u003econnections to the broker.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.hosts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.hosts.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleSearchMatching\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleSearchSubtree\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.serviceAccountPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.serviceAccountUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userBase\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userSearchMatching\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userSearchSubtree\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of information about logs to be enabled for the specified broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs.audit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs.general\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe scheduled time period relative to UTC during which Amazon MQ begins to\u003cbr/\u003eapply pending updates or patches to the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.dayOfWeek\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.timeOfDay\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.timeZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA user associated with the broker. For RabbitMQ brokers, one and only one\nadministrative user is accepted and created when a broker is first provisioned.\nAll subsequent broker users are created by making RabbitMQ API calls directly\nto brokers or via the RabbitMQ web console. || \u003cstrong\u003eusers.[].consoleAccess\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[].groups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[].groups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eusers.[].password\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret |\n| \u003cstrong\u003eusers.[].password.key\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret |\n| \u003cstrong\u003eusers.[].password.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource. |\n| \u003cstrong\u003eusers.[].password.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique. |\n| \u003cstrong\u003eusers.[].username\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbrokerID: string\nbrokerInstances:\n- consoleURL: string\n endpoints:\n - string\n ipAddress: string\nbrokerState: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns information about all brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[].endpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[].endpoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:61,href:"https://aws-controllers-k8s.github.io/community/reference/s3/v1alpha1/bucket/",title:"Bucket",description:null,content:'\u003cp\u003e\u003ccode\u003es3.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/s3-controller/apis/v1alpha1#Bucket"\u003es3-controller/apis/v1alpha1#Bucket\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBucket\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBucketList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebuckets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebucket\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIn terms of implementation, a Bucket is a resource. An Amazon S3 bucket name\nis globally unique, and the namespace is shared by all Amazon Web Services\naccounts.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccelerate: \n status: string\nacl: string\nanalytics:\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n storageClassAnalysis: \n dataExport: \n destination: \n s3BucketDestination: \n bucket: string\n bucketAccountID: string\n format: string\n prefix: string\n outputSchemaVersion: string\ncors: \n corsRules:\n allowedHeaders:\n - string\n allowedMethods:\n - string\n allowedOrigins:\n - string\n exposeHeaders:\n - string\n id: string\n maxAgeSeconds: integer\ncreateBucketConfiguration: \n locationConstraint: string\nencryption: \n rules:\n applyServerSideEncryptionByDefault: \n kmsMasterKeyID: string\n sseAlgorithm: string\n bucketKeyEnabled: boolean\ngrantFullControl: string\ngrantRead: string\ngrantReadACP: string\ngrantWrite: string\ngrantWriteACP: string\nintelligentTiering:\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n status: string\n tierings:\n - accessTier: string\n days: integer\ninventory:\n destination: \n s3BucketDestination: \n accountID: string\n bucket: string\n encryption: \n sseKMS: \n keyID: string\n format: string\n prefix: string\n filter: \n prefix: string\n id: string\n includedObjectVersions: string\n isEnabled: boolean\n optionalFields:\n - string\n schedule: \n frequency: string\nlifecycle: \n rules:\n abortIncompleteMultipartUpload: \n daysAfterInitiation: integer\n expiration: \n date: string\n days: integer\n expiredObjectDeleteMarker: boolean\n filter: \n and: \n objectSizeGreaterThan: integer\n objectSizeLessThan: integer\n prefix: string\n tags:\n - key: string\n value: string\n objectSizeGreaterThan: integer\n objectSizeLessThan: integer\n prefix: string\n tag: \n key: string\n value: string\n id: string\n noncurrentVersionExpiration: \n newerNoncurrentVersions: integer\n noncurrentDays: integer\n noncurrentVersionTransitions:\n - newerNoncurrentVersions: integer\n noncurrentDays: integer\n storageClass: string\n prefix: string\n status: string\n transitions:\n - date: string\n days: integer\n storageClass: string\nlogging: \n loggingEnabled: \n targetBucket: string\n targetGrants:\n grantee: \n displayName: string\n emailAddress: string\n id: string\n type_: string\n uRI: string\n permission: string\n targetPrefix: string\nmetrics:\n filter: \n accessPointARN: string\n and: \n accessPointARN: string\n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\nname: string\nnotification: \n lambdaFunctionConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n lambdaFunctionARN: string\n queueConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n queueARN: string\n topicConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n topicARN: string\nobjectLockEnabledForBucket: boolean\nobjectOwnership: string\nownershipControls: \n rules:\n - objectOwnership: string\npolicy: string\npublicAccessBlock: \n blockPublicACLs: boolean\n blockPublicPolicy: boolean\n ignorePublicACLs: boolean\n restrictPublicBuckets: boolean\nreplication: \n role: string\n rules:\n deleteMarkerReplication: \n status: string\n destination: \n accessControlTranslation: \n owner: string\n account: string\n bucket: string\n encryptionConfiguration: \n replicaKMSKeyID: string\n metrics: \n eventThreshold: \n minutes: integer\n status: string\n replicationTime: \n status: string\n time: \n minutes: integer\n storageClass: string\n existingObjectReplication: \n status: string\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n prefix: string\n priority: integer\n sourceSelectionCriteria: \n replicaModifications: \n status: string\n sseKMSEncryptedObjects: \n status: string\n status: string\nrequestPayment: \n payer: string\ntagging: \n tagSet:\n - key: string\n value: string\nversioning: \n status: string\nwebsite: \n errorDocument: \n key: string\n indexDocument: \n suffix: string\n redirectAllRequestsTo: \n hostName: string\n protocol: string\n routingRules:\n condition: \n httpErrorCodeReturnedEquals: string\n keyPrefixEquals: string\n redirect: \n hostName: string\n httpRedirectCode: string\n protocol: string\n replaceKeyPrefixWith: string\n replaceKeyWith: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccelerate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for setting the transfer acceleration state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccelerate.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe canned ACL to apply to the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration and any analyses for the analytics filter of\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ean Amazon S3 bucket.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA conjunction (logical AND) of predicates, which is used in evaluating a\u003cbr/\u003emetrics filter. The operator must have at least two predicates in any combination,\u003cbr/\u003eand an object must match all of the predicates for the filter to apply.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies data related to access patterns to be collected and made available\u003cbr/\u003eto analyze the tradeoffs between different storage classes for an Amazon\u003cbr/\u003eS3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for data related to the storage class analysis for an Amazon S3\u003cbr/\u003ebucket for export.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWhere to publish the analytics results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about where to publish the analytics results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.bucketAccountID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.format\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.outputSchemaVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the cross-origin access configuration for objects in an Amazon\u003cbr/\u003eS3 bucket. For more information, see Enabling Cross-Origin Resource Sharing\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon\u003cbr/\u003eS3 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a cross-origin access rule for an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].maxAgeSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateBucketConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration information for the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateBucketConfiguration.locationConstraint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the default server-side-encryption configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the default server-side encryption configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].applyServerSideEncryptionByDefault.kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].applyServerSideEncryptionByDefault.sseAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].bucketKeyEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantFullControl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee the read, write, read ACP, and write ACP permissions on the\u003cbr/\u003ebucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantRead\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to list the objects in the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantReadACP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to read the bucket ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantWrite\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to create new objects in the bucket.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the bucket and object owners of existing objects, also allows deletions\u003cbr/\u003eand overwrites of those objects.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantWriteACP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to write the ACL for the applicable bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintelligentTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintelligentTiering.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor information about the S3 Intelligent-Tiering storage class, see Storage\nclass for automatically optimizing frequently and infrequently accessed objects\n(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). || \u003cstrong\u003eintelligentTiering.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Filter is used to identify objects that the S3 Intelligent-Tiering configuration\u003cbr/\u003eapplies to. |\n| \u003cstrong\u003eintelligentTiering.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container for specifying S3 Intelligent-Tiering filters. The filters determine\u003cbr/\u003ethe subset of objects to which the rule applies. |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. || \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe S3 Intelligent-Tiering storage class is designed to optimize storage\ncosts by automatically moving data to the most cost-effective storage access\ntier, without additional operational overhead. || \u003cstrong\u003eintelligentTiering.[].tierings.[].accessTier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings.[].days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the inventory configuration for an Amazon S3 bucket. For more information,\nsee GET Bucket inventory (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html)\nin the Amazon S3 API Reference. || \u003cstrong\u003einventory.[].destination\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the inventory configuration for an Amazon S3 bucket. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the bucket name, file format, bucket owner (optional), and prefix\u003cbr/\u003e(optional) where inventory results are published. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.accountID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.bucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the type of server-side encryption used to encrypt the inventory\u003cbr/\u003eresults. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption.sseKMS\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the use of SSE-KMS to encrypt delivered inventory reports. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption.sseKMS.keyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.format\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an inventory filter. The inventory only includes objects that meet\u003cbr/\u003ethe filter\u0026rsquo;s criteria. |\n| \u003cstrong\u003einventory.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].includedObjectVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].isEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].optionalFields\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].optionalFields.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003einventory.[].schedule\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the schedule for generating inventory results. |\n| \u003cstrong\u003einventory.[].schedule.frequency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for lifecycle rules. You can add as many as 1,000 rules. |\n| \u003cstrong\u003elifecycle.rules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA lifecycle rule for individual objects in an Amazon S3 bucket. || \u003cstrong\u003elifecycle.rules.[].abortIncompleteMultipartUpload\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the days since the initiation of an incomplete multipart upload\u003cbr/\u003ethat Amazon S3 will wait before permanently removing all parts of the upload.\u003cbr/\u003eFor more information, see Aborting Incomplete Multipart Uploads Using a Bucket\u003cbr/\u003eLifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| \u003cstrong\u003elifecycle.rules.[].abortIncompleteMultipartUpload.daysAfterInitiation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the expiration for the lifecycle of the object. |\n| \u003cstrong\u003elifecycle.rules.[].expiration.date\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration.days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration.expiredObjectDeleteMarker\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Filter is used to identify objects that a Lifecycle Rule applies to.\u003cbr/\u003eA Filter must have exactly one of Prefix, Tag, or And specified. |\n| \u003cstrong\u003elifecycle.rules.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis is used in a Lifecycle Rule Filter to apply a logical AND to two or\u003cbr/\u003emore predicates. The Lifecycle Rule will apply to any object matching all\u003cbr/\u003eof the predicates configured inside the And operator. |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.objectSizeGreaterThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.objectSizeLessThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. || \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.objectSizeGreaterThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.objectSizeLessThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies when noncurrent object versions expire. Upon expiration, Amazon\u003cbr/\u003eS3 permanently deletes the noncurrent object versions. You set this lifecycle\u003cbr/\u003econfiguration action on a bucket that has versioning enabled (or suspended)\u003cbr/\u003eto request that Amazon S3 delete noncurrent object versions at a specific\u003cbr/\u003eperiod in the object\u0026rsquo;s lifetime. |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration.newerNoncurrentVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration.noncurrentDays\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the transition rule that describes when noncurrent objects\ntransition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR,\nGLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled\n(or versioning is suspended), you can set this action to request that Amazon\nS3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA,\nINTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at\na specific period in the object\u0026rsquo;s lifetime. || \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].newerNoncurrentVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].noncurrentDays\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].storageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies when an object transitions to a specified storage class. For more\ninformation about Amazon S3 lifecycle configuration rules, see Transitioning\nObjects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html)\nin the Amazon S3 User Guide. || \u003cstrong\u003elifecycle.rules.[].transitions.[].date\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[].days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[].storageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for logging status information. |\n| \u003cstrong\u003elogging.loggingEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes where logs are stored and the prefix that Amazon S3 assigns to\u003cbr/\u003eall log object keys for a bucket. For more information, see PUT Bucket logging\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html)\u003cbr/\u003ein the Amazon S3 API Reference. |\n| \u003cstrong\u003elogging.loggingEnabled.targetBucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for granting information.\u003c/p\u003e\n\u003cp\u003eBuckets that use the bucket owner enforced setting for Object Ownership don\u0026rsquo;t\nsupport target grants. For more information, see Permissions server access\nlog delivery (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general)\nin the Amazon S3 User Guide. || \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the person being granted permissions. |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.displayName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.emailAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].grantee.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].grantee.uRI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].permission**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetPrefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **metrics.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies a metrics configuration for the CloudWatch request metrics (specified\nby the metrics configuration ID) from an Amazon S3 bucket. If you\u0026rsquo;re updating\nan existing metrics configuration, note that this is a full replacement of\nthe existing metrics configuration. If you don\u0026rsquo;t include the elements you\nwant to keep, they are erased. For more information, see PutBucketMetricsConfiguration\n(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). || **metrics.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a metrics configuration filter. The metrics configuration only\u003cbr/\u003eincludes objects that meet the filter\u0026rsquo;s criteria. A filter must be a prefix,\u003cbr/\u003ean object tag, an access point ARN, or a conjunction (MetricsAndOperator).\u003cbr/\u003eFor more information, see PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). |\n| **metrics.[].filter.accessPointARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA conjunction (logical AND) of predicates, which is used in evaluating a\u003cbr/\u003emetrics filter. The operator must have at least two predicates, and an object\u003cbr/\u003emust match all of the predicates in order for the filter to apply. |\n| **metrics.[].filter.and.accessPointARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **metrics.[].filter.and.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.tag**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container of a key value name pair. |\n| **metrics.[].filter.tag.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.tag.value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **name**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe name of the bucket to create. |\n| **notification**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for specifying the notification configuration of the bucket.\u003cbr/\u003eIf this element is empty, notifications are turned off for the bucket. |\n| **notification.lambdaFunctionConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container for specifying the configuration for Lambda notifications. || **notification.lambdaFunctionConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.lambdaFunctionConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.lambdaFunctionConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.lambdaFunctionConfigurations.[].lambdaFunctionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.queueConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the configuration for publishing messages to an Amazon Simple Queue\nService (Amazon SQS) queue when Amazon S3 detects specified events. || **notification.queueConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.queueConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.queueConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.queueConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.queueConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.queueConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.queueConfigurations.[].queueARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.topicConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container for specifying the configuration for publication of messages\nto an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3\ndetects specified events. || **notification.topicConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.topicConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.topicConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.topicConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.topicConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.topicConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.topicConfigurations.[].topicARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **objectLockEnabledForBucket**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003eSpecifies whether you want S3 Object Lock to be enabled for the new bucket. |\n| **objectOwnership**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **ownershipControls**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter)\u003cbr/\u003ethat you want to apply to this Amazon S3 bucket. |\n| **ownershipControls.rules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **ownershipControls.rules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe container element for an ownership control rule. || **ownershipControls.rules.[].objectOwnership**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe container element for object ownership for a bucket\u0026rsquo;s ownership controls.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBucketOwnerPreferred - Objects uploaded to the bucket change ownership to\u003cbr/\u003ethe bucket owner if the objects are uploaded with the bucket-owner-full-control\u003cbr/\u003ecanned ACL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eObjectWriter - The uploading account will own the object if the object is\u003cbr/\u003euploaded with the bucket-owner-full-control canned ACL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer\u003cbr/\u003eaffect permissions. The bucket owner automatically owns and has full control\u003cbr/\u003eover every object in the bucket. The bucket only accepts PUT requests that\u003cbr/\u003edon\u0026rsquo;t specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control\u003cbr/\u003ecanned ACL or an equivalent form of this ACL expressed in the XML format. |\n| **policy**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe bucket policy as a JSON document. |\n| **publicAccessBlock**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe PublicAccessBlock configuration that you want to apply to this Amazon\u003cbr/\u003eS3 bucket. You can enable the configuration options in any combination. For\u003cbr/\u003emore information about when Amazon S3 considers a bucket or object public,\u003cbr/\u003esee The Meaning of \u0026ldquo;Public\u0026rdquo; (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **publicAccessBlock.blockPublicACLs**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.blockPublicPolicy**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.ignorePublicACLs**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.restrictPublicBuckets**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **replication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for replication rules. You can add up to 1,000 rules. The maximum\u003cbr/\u003esize of a replication configuration is 2 MB. |\n| **replication.role**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **replication.rules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies which Amazon S3 objects to replicate and where to store the replicas. || **replication.rules.[].deleteMarkerReplication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies whether Amazon S3 replicates delete markers. If you specify a Filter\u003cbr/\u003ein your replication configuration, you must also include a DeleteMarkerReplication\u003cbr/\u003eelement. If your Filter includes a Tag element, the DeleteMarkerReplication\u003cbr/\u003eStatus must be set to Disabled, because Amazon S3 does not support replicating\u003cbr/\u003edelete markers for tag-based rules. For an example configuration, see Basic\u003cbr/\u003eRule Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about delete marker replication, see Basic Rule Configuration\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an earlier version of the replication configuration, Amazon\u003cbr/\u003eS3 handles replication of delete markers differently. For more information,\u003cbr/\u003esee Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). |\n| **replication.rules.[].deleteMarkerReplication.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies information about where to publish analysis or configuration results\u003cbr/\u003efor an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). |\n| **replication.rules.[].destination.accessControlTranslation**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for information about access control for replicas. |\n| **replication.rules.[].destination.accessControlTranslation.owner**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.account**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.bucket**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.encryptionConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies encryption-related information for an Amazon S3 bucket that is\u003cbr/\u003ea destination for replicated objects. |\n| **replication.rules.[].destination.encryptionConfiguration.replicaKMSKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.metrics**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying replication metrics-related settings enabling replication\u003cbr/\u003emetrics and events. |\n| **replication.rules.[].destination.metrics.eventThreshold**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying the time value for S3 Replication Time Control (S3\u003cbr/\u003eRTC) and replication metrics EventThreshold. |\n| **replication.rules.[].destination.metrics.eventThreshold.minutes**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].destination.metrics.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.replicationTime**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying S3 Replication Time Control (S3 RTC) related information,\u003cbr/\u003eincluding whether S3 RTC is enabled and the time when all objects and operations\u003cbr/\u003eon objects must be replicated. Must be specified together with a Metrics\u003cbr/\u003eblock. |\n| **replication.rules.[].destination.replicationTime.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.replicationTime.time**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying the time value for S3 Replication Time Control (S3\u003cbr/\u003eRTC) and replication metrics EventThreshold. |\n| **replication.rules.[].destination.replicationTime.time.minutes**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].destination.storageClass**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].existingObjectReplication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eOptional configuration to replicate existing source bucket objects. For more\u003cbr/\u003einformation, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **replication.rules.[].existingObjectReplication.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA filter that identifies the subset of objects to which the replication rule\u003cbr/\u003eapplies. A Filter must specify exactly one Prefix, Tag, or an And child element. |\n| **replication.rules.[].filter.and**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for specifying rule filters. The filters determine the subset\u003cbr/\u003eof objects to which the rule applies. This element is required only if you\u003cbr/\u003especify more than one filter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you specify both a Prefix and a Tag filter, wrap these filters in\u003cbr/\u003e an And tag.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you specify a filter based on multiple tags, wrap the Tag elements\u003cbr/\u003e in an And tag. |\n| **replication.rules.[].filter.and.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **replication.rules.[].filter.and.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.tag**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container of a key value name pair. |\n| **replication.rules.[].filter.tag.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.tag.value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].priority**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].sourceSelectionCriteria**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container that describes additional filters for identifying the source\u003cbr/\u003eobjects that you want to replicate. You can choose to enable or disable the\u003cbr/\u003ereplication of these objects. Currently, Amazon S3 supports only the filter\u003cbr/\u003ethat you can specify for objects created with server-side encryption using\u003cbr/\u003ea customer managed key stored in Amazon Web Services Key Management Service\u003cbr/\u003e(SSE-KMS). |\n| **replication.rules.[].sourceSelectionCriteria.replicaModifications**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA filter that you can specify for selection for modifications on replicas.\u003cbr/\u003eAmazon S3 doesn\u0026rsquo;t replicate replica modifications by default. In the latest\u003cbr/\u003eversion of replication configuration (when Filter is specified), you can\u003cbr/\u003especify this element and set the status to Enabled to replicate modifications\u003cbr/\u003eon replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify the Filter element, Amazon S3 assumes that the replication\u003cbr/\u003econfiguration is the earlier version, V1. In the earlier version, this element\u003cbr/\u003eis not allowed. |\n| **replication.rules.[].sourceSelectionCriteria.replicaModifications.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].sourceSelectionCriteria.sseKMSEncryptedObjects**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for filter information for the selection of S3 objects encrypted\u003cbr/\u003ewith Amazon Web Services KMS. |\n| **replication.rules.[].sourceSelectionCriteria.sseKMSEncryptedObjects.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **requestPayment**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for Payer. |\n| **requestPayment.payer**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tagging**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the TagSet and Tag elements. |\n| **tagging.tagSet**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **tagging.tagSet.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **tagging.tagSet.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tagging.tagSet.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **versioning**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for setting the versioning state. |\n| **versioning.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the request. |\n| **website.errorDocument**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe error information. |\n| **website.errorDocument.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.indexDocument**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the Suffix element. |\n| **website.indexDocument.suffix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.redirectAllRequestsTo**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies the redirect behavior of all requests to a website endpoint of\u003cbr/\u003ean Amazon S3 bucket. |\n| **website.redirectAllRequestsTo.hostName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.redirectAllRequestsTo.protocol**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **website.routingRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the redirect behavior and when a redirect is applied. For more\ninformation about routing rules, see Configuring advanced conditional redirects\n(https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects)\nin the Amazon S3 User Guide. || **website.routingRules.[].condition**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for describing a condition that must be met for the specified\u003cbr/\u003eredirect to apply. For example, 1. If request is for pages in the /docs folder,\u003cbr/\u003eredirect to the /documents folder. 2. If request results in HTTP error 4xx,\u003cbr/\u003eredirect request to another host where you might process the error. |\n| **website.routingRules.[].condition.httpErrorCodeReturnedEquals**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].condition.keyPrefixEquals**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies how requests are redirected. In the event of an error, you can\u003cbr/\u003especify a different error code to return. |\n| **website.routingRules.[].redirect.hostName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.httpRedirectCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.protocol**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.replaceKeyPrefixWith**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.replaceKeyWith**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA forward slash followed by the name of the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:62,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/cacheparametergroup/",title:"CacheParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#CacheParameterGroup"\u003eelasticache-controller/apis/v1alpha1#CacheParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecacheparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecacheparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of a CreateCacheParameterGroup operation.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheParameterGroupFamily: string\ncacheParameterGroupName: string\ndescription: string\nparameterNameValues:\n- parameterName: string\n parameterValue: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupFamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache parameter group family that the cache parameter group can be used with. \u003cbr/\u003e Valid values are: memcached1.4\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-specified name for the cache parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-specified description for the cache parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a name-value pair that is used to update the value of a parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nisGlobal: boolean\nparameters:\n- allowedValues: string\n changeType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisGlobal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the parameter group is associated with a Global datastore\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Parameter instances.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an individual setting that controls some aspect of ElastiCache behavior.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].changeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].source\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:63,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/cachepolicy/",title:"CachePolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#CachePolicy"\u003ecloudfront-controller/apis/v1alpha1#CachePolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCachePolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCachePolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachepolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachepolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA cache policy.\u003c/p\u003e\n\u003cp\u003eWhen it\u0026rsquo;s attached to a cache behavior, the cache policy determines the following:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe values that CloudFront includes in the cache key. These values can\ninclude HTTP headers, cookies, and URL query strings. CloudFront uses\nthe cache key to find an object in its cache that it can return to the\nviewer.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe default, minimum, and maximum time to live (TTL) values that you\nwant objects to stay in the CloudFront cache.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe headers, cookies, and query strings that are included in the cache key\nare also included in requests that CloudFront sends to the origin. CloudFront\nsends a request when it can\u0026rsquo;t find a valid object in its cache that matches\nthe request\u0026rsquo;s cache key. If you want to send values to the origin but not\ninclude them in the cache key, use OriginRequestPolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecachePolicyConfig: \n comment: string\n defaultTTL: integer\n maxTTL: integer\n minTTL: integer\n name: string\n parametersInCacheKeyAndForwardedToOrigin: \n cookiesConfig: \n cookieBehavior: string\n cookies: \n items:\n - string\n enableAcceptEncodingBrotli: boolean\n enableAcceptEncodingGzip: boolean\n headersConfig: \n headerBehavior: string\n headers: \n items:\n - string\n queryStringsConfig: \n queryStringBehavior: string\n queryStrings: \n items:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA cache policy configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.minTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis object determines the values that CloudFront includes in the cache key.\u003cbr/\u003eThese values can include HTTP headers, cookies, and URL query strings. CloudFront\u003cbr/\u003euses the cache key to find an object in its cache that it can return to the\u003cbr/\u003eviewer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe headers, cookies, and query strings that are included in the cache key\u003cbr/\u003eare also included in requests that CloudFront sends to the origin. CloudFront\u003cbr/\u003esends a request when it can\u0026rsquo;t find an object in its cache that matches the\u003cbr/\u003erequest\u0026rsquo;s cache key. If you want to send values to the origin but not include\u003cbr/\u003ethem in the cache key, use OriginRequestPolicy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any cookies in viewer requests (and if\u003cbr/\u003eso, which cookies) are included in the cache key and in requests that CloudFront\u003cbr/\u003esends to the origin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookieBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.enableAcceptEncodingGzip\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any HTTP headers (and if so, which headers)\u003cbr/\u003eare included in the cache key and in requests that CloudFront sends to the\u003cbr/\u003eorigin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headerBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStringBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of query string names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current version of the cache policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the cache policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the cache policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:64,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/cachesubnetgroup/",title:"CacheSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#CacheSubnetGroup"\u003eelasticache-controller/apis/v1alpha1#CacheSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachesubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachesubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of one of the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreateCacheSubnetGroup\u003c/li\u003e\n\u003cli\u003eModifyCacheSubnetGroup\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheSubnetGroupDescription: string\ncacheSubnetGroupName: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the cache subnet group. This value is stored as a lowercase string. \u003cbr/\u003e Constraints: Must contain no more than 255 alphanumeric characters or hyphens. \u003cbr/\u003e Example: mysubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of VPC subnet IDs for the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n subnetOutpostARN: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of subnets associated with the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID of the outpost subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost.subnetOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:65,href:"https://aws-controllers-k8s.github.io/community/reference/acm/v1alpha1/certificate/",title:"Certificate",description:null,content:'\u003cp\u003e\u003ccode\u003eacm.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acm-controller/apis/v1alpha1#Certificate"\u003eacm-controller/apis/v1alpha1#Certificate\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificates\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificateAuthorityARN: string\ndomainName: string\ndomainValidationOptions:\n- domainName: string\n validationDomain: string\nkeyAlgorithm: string\noptions: \n certificateTransparencyLoggingPreference: string\nsubjectAlternativeNames:\n- string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the private certificate authority (CA)\u003cbr/\u003ethat will be used to issue the certificate. If you do not provide an ARN\u003cbr/\u003eand you are trying to request a private certificate, ACM will attempt to\u003cbr/\u003eissue a public certificate. For more information about private CAs, see the\u003cbr/\u003eAmazon Web Services Private Certificate Authority (https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html)\u003cbr/\u003euser guide. The ARN must have the following form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFully qualified domain name (FQDN), such as www.example.com, that you want\u003cbr/\u003eto secure with an ACM certificate. Use an asterisk (\u003cem\u003e) to create a wildcard\u003cbr/\u003ecertificate that protects several sites in the same domain. For example,\u003cbr/\u003e\u003c/em\u003e.example.com protects www.example.com, site.example.com, and images.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIn compliance with RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280),\u003cbr/\u003ethe length of the domain name (technically, the Common Name) that you provide\u003cbr/\u003ecannot exceed 64 octets (characters), including periods. To add a longer\u003cbr/\u003edomain name, specify it in the Subject Alternative Name field, which supports\u003cbr/\u003enames up to 253 octets in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe domain name that you want ACM to use to send you emails so that you can\u003cbr/\u003evalidate domain ownership.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the domain names that you want ACM to use to send\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou emails that enable you to validate domain ownership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the algorithm of the public and private key pair that your certificate\u003cbr/\u003euses to encrypt data. RSA is the default key algorithm for ACM certificates.\u003cbr/\u003eElliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering\u003cbr/\u003esecurity comparable to RSA keys but with greater computing efficiency. However,\u003cbr/\u003eECDSA is not supported by all network clients. Some AWS services may require\u003cbr/\u003eRSA keys, or only support ECDSA keys of a particular size, while others allow\u003cbr/\u003ethe use of either RSA and ECDSA keys to ensure that compatibility is not\u003cbr/\u003ebroken. Check the requirements for the AWS service where you plan to deploy\u003cbr/\u003eyour certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: RSA_2048\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCurrently, you can use this parameter to specify whether to add the certificate\u003cbr/\u003eto a certificate transparency log. Certificate transparency makes it possible\u003cbr/\u003eto detect SSL/TLS certificates that have been mistakenly or maliciously issued.\u003cbr/\u003eCertificates that have not been logged typically produce an error message\u003cbr/\u003ein a browser. For more information, see Opting Out of Certificate Transparency\u003cbr/\u003eLogging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.certificateTransparencyLoggingPreference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubjectAlternativeNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAdditional FQDNs to be included in the Subject Alternative Name extension\u003cbr/\u003eof the ACM certificate. For example, add the name www.example.net to a certificate\u003cbr/\u003efor which the DomainName field is www.example.com if users can reach your\u003cbr/\u003esite by using either name. The maximum number of domain names that you can\u003cbr/\u003eadd to an ACM certificate is 100. However, the initial quota is 10 domain\u003cbr/\u003enames. If you need more than 10 names, you must request a quota increase.\u003cbr/\u003eFor more information, see Quotas (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum length of a SAN DNS name is 253 octets. The name is made up of\u003cbr/\u003emultiple labels separated by periods. No label can be longer than 63 octets.\u003cbr/\u003eConsider the following examples:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (63 octets).(63 octets).(63 octets).(61 octets) is legal because the\u003cbr/\u003e total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63\u003cbr/\u003e octets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (64 octets).(63 octets).(63 octets).(61 octets) is not legal because\u003cbr/\u003e the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first\u003cbr/\u003e label exceeds 63 octets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (63 octets).(63 octets).(63 octets).(62 octets) is not legal because\u003cbr/\u003e the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubjectAlternativeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair that identifies or specifies metadata about an ACM resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\ndomainValidations:\n- domainName: string\n resourceRecord: \n name: string\n type_: string\n value: string\n validationDomain: string\n validationEmails:\n - string\n validationMethod: string\n validationStatus: string\nextendedKeyUsages:\n- name: string\n oid: string\nfailureReason: string\nimportedAt: string\ninUseBy:\n- string\nissuedAt: string\nissuer: string\nkeyUsages:\n- name: string\nnotAfter: string\nnotBefore: string\nrenewalEligibility: string\nrenewalSummary: \n domainValidationOptions:\n - domainName: string\n resourceRecord: \n name: string\n type_: string\n value: string\n validationDomain: string\n validationEmails:\n - string\n validationMethod: string\n validationStatus: string\n renewalStatus: string\n renewalStatusReason: string\n updatedAt: string\nrevocationReason: string\nrevokedAt: string\nserial: string\nsignatureAlgorithm: string\nstatus: string\nsubject: string\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the certificate was requested.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains information about the initial validation of each domain name that\u003cbr/\u003eoccurs as a result of the RequestCertificate request. This field exists only\u003cbr/\u003ewhen the certificate type is AMAZON_ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the validation of each domain name in the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a DNS record value that you can use to validate ownership or control\u003cbr/\u003eof a domain. This is used by the DescribeCertificate action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**domainValidations.[].resourceRecord.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationEmails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationEmails.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of Extended Key Usage X.509 v3 extension objects. Each object\u003cbr/\u003especifies a purpose for which the certificate public key can be used and\u003cbr/\u003econsists of a name and an object identifier (OID).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Extended Key Usage X.509 v3 extension defines one or more purposes for\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewhich the public key can be used. This is in addition to or in place of the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ebasic purposes specified by the Key Usage extension.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages.[].oid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the certificate request failed. This value exists only when the\u003cbr/\u003ecertificate status is FAILED. For more information, see Certificate Request\u003cbr/\u003eFailed (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed)\u003cbr/\u003ein the Certificate Manager User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the certificate was imported. This value exists only\u003cbr/\u003ewhen the certificate type is IMPORTED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einUseBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of ARNs for the Amazon Web Services resources that are using the certificate.\u003cbr/\u003eA certificate can be used by multiple Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einUseBy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eissuer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the certificate authority that issued and signed the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Key Usage X.509 v3 extension objects. Each object is a string value\u003cbr/\u003ethat identifies the purpose of the public key contained in the certificate.\u003cbr/\u003ePossible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION,\u003cbr/\u003eand more.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Key Usage X.509 v3 extension defines the purpose of the public key contained\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the certificate.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotAfter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time after which the certificate is not valid.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotBefore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time before which the certificate is not valid.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalEligibility\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the certificate is eligible for renewal. At this time,\u003cbr/\u003eonly exported private certificates can be renewed with the RenewCertificate\u003cbr/\u003ecommand.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the status of ACM\u0026rsquo;s managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)\u003cbr/\u003efor the certificate. This field exists only when the certificate type is\u003cbr/\u003eAMAZON_ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the validation of each domain name in the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a DNS record value that you can use to validate ownership or control\u003cbr/\u003eof a domain. This is used by the DescribeCertificate action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**renewalSummary.domainValidationOptions.[].resourceRecord.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationEmails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationEmails.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.renewalStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.renewalStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the certificate was revoked. This value exists only when the certificate\u003cbr/\u003estatus is REVOKED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevokedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the certificate was revoked. This value exists only when\u003cbr/\u003ethe certificate status is REVOKED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserial\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe serial number of the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esignatureAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe algorithm that was used to sign the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA certificate enters status PENDING_VALIDATION upon being requested, unless\u003cbr/\u003eit fails for any of the reasons given in the troubleshooting topic Certificate\u003cbr/\u003erequest fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html).\u003cbr/\u003eACM makes repeated attempts to validate a certificate for 72 hours and then\u003cbr/\u003etimes out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT,\u003cbr/\u003edelete the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html)\u003cbr/\u003eor Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html),\u003cbr/\u003eand try again. If validation succeeds, the certificate enters status ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubject\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the entity that is associated with the public key contained in\u003cbr/\u003ethe certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe source of the certificate. For certificates provided by ACM, this value\u003cbr/\u003eis AMAZON_ISSUED. For certificates that you imported with ImportCertificate,\u003cbr/\u003ethis value is IMPORTED. ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)\u003cbr/\u003efor imported certificates. For more information about the differences between\u003cbr/\u003ecertificates that you import and those that ACM provides, see Importing Certificates\u003cbr/\u003e(https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)\u003cbr/\u003ein the Certificate Manager User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:66,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificate/",title:"Certificate",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#Certificate"\u003eacmpca-controller/apis/v1alpha1#Certificate\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificates\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiPassthrough: \n extensions: \n certificatePolicies:\n - certPolicyID: string\n policyQualifiers:\n - policyQualifierID: string\n qualifier: \n cpsURI: string\n customExtensions:\n - critical: boolean\n objectIdentifier: string\n value: string\n extendedKeyUsage:\n - extendedKeyUsageObjectIdentifier: string\n extendedKeyUsageType: string\n keyUsage: \n crlSign: boolean\n dataEncipherment: boolean\n decipherOnly: boolean\n digitalSignature: boolean\n encipherOnly: boolean\n keyAgreement: boolean\n keyCertSign: boolean\n keyEncipherment: boolean\n nonRepudiation: boolean\n subjectAlternativeNames:\n directoryName: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\n dnsName: string\n ediPartyName: \n nameAssigner: string\n partyName: string\n ipAddress: string\n otherName: \n typeID: string\n value: string\n registeredID: string\n rfc822Name: string\n uniformResourceIdentifier: string\n subject: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\ncertificateAuthorityARN: string\ncertificateAuthorityRef: \n from: \n name: string\ncsr: string\ncsrRef: \n from: \n name: string\nsigningAlgorithm: string\ntemplateARN: string\nvalidity: \n type_: string\n value: integer\nvalidityNotBefore: \n type_: string\n value: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies X.509 certificate information to be included in the issued certificate.\u003cbr/\u003eAn APIPassthrough or APICSRPassthrough template variant must be selected,\u003cbr/\u003eor else this parameter is ignored. For more information about using these\u003cbr/\u003etemplates, see Understanding Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf conflicting or duplicate certificate information is supplied during certificate\u003cbr/\u003eissuance, Amazon Web Services Private CA applies order of operation rules\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations)\u003cbr/\u003eto determine what information is used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains X.509 extension information for a certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.509 CertificatePolicies extension.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eModifies the CertPolicyId of a PolicyInformation object with a qualifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAmazon Web Services Private CA supports the certification practice statement\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(CPS) qualifier.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[].qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a PolicyInformation qualifier. Amazon Web Services Private CA supports\u003cbr/\u003ethe certification practice statement (CPS) qualifier (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4)\u003cbr/\u003edefined in RFC 5280.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[].qualifier.cpsURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.customExtensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.customExtensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the X.509 extension information for a certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eExtensions present in CustomExtensions follow the ApiPassthrough template\nrules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). || \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].critical\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional purposes for which the certified public key may be used\nother than basic purposes indicated in the KeyUsage extension. || \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[].extendedKeyUsageObjectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[].extendedKeyUsageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines one or more purposes for which the key contained in the certificate\u003cbr/\u003ecan be used. Default value for each option is false. |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.crlSign\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.dataEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.decipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.digitalSignature\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.encipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyAgreement\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyCertSign\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.nonRepudiation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an ASN.1 X.400 GeneralName as defined in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280).\nOnly one of the following naming options should be provided. Providing more\nthan one option results in an InvalidArgsException error. || \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate. |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.commonName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.country\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN). || \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.givenName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.initials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.locality\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.organization\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.state\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.surname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.title\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Electronic Data Interchange (EDI) entity as described in as\u003cbr/\u003edefined in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280)\u003cbr/\u003ein RFC 5280. |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName.nameAssigner\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName.partyName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a custom ASN.1 X.400 GeneralName using an object identifier (OID)\u003cbr/\u003eand value. The OID must satisfy the regular expression shown below. For more\u003cbr/\u003einformation, see NIST\u0026rsquo;s definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName.typeID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].registeredID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].rfc822Name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].uniformResourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate. |\n| \u003cstrong\u003eapiPassthrough.subject.commonName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.country\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN). || \u003cstrong\u003eapiPassthrough.subject.customAttributes.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.givenName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.initials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.locality\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.organization\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.state\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.surname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.title\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html).\u003cbr/\u003eThis must be of the form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 |\n| \u003cstrong\u003ecertificateAuthorityRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003ecertificateAuthorityRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003ecertificateAuthorityRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecsr\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe certificate signing request (CSR) for the certificate you want to issue.\u003cbr/\u003eAs an example, you can use the following OpenSSL command to create the CSR\u003cbr/\u003eand a 2048 bit RSA private key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\u003cbr/\u003e-out csr/test_cert_.csr\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you have a configuration file, you can then use the following OpenSSL\u003cbr/\u003ecommand. The usr_cert block in the configuration file contains your X509\u003cbr/\u003eversion 3 extensions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\u003cbr/\u003e-days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: A CSR must provide either a subject name or a subject alternative name\u003cbr/\u003eor the request will be rejected. |\n| **csrRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **csrRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **csrRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **signingAlgorithm**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe name of the algorithm that will be used to sign the certificate to be\u003cbr/\u003eissued.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter should not be confused with the SigningAlgorithm parameter\u003cbr/\u003eused to sign a CSR in the CreateCertificateAuthority action.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe specified signing algorithm family (RSA or ECDSA) must match the algorithm\u003cbr/\u003efamily of the CA\u0026rsquo;s secret key. |\n| **templateARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eSpecifies a custom configuration template to use when issuing a certificate.\u003cbr/\u003eIf this parameter is not provided, Amazon Web Services Private CA defaults\u003cbr/\u003eto the EndEntityCertificate/V1 template. For CA certificates, you should\u003cbr/\u003echoose the shortest path length that meets your needs. The path length is\u003cbr/\u003eindicated by the PathLenN portion of the ARN, where N is the CA depth (https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: The CA depth configured on a subordinate CA certificate must not exceed\u003cbr/\u003ethe limit set by its parents in the CA hierarchy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of TemplateArn values supported by Amazon Web Services Private\u003cbr/\u003eCA, see Understanding Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html). |\n| **validity**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation describing the end of the validity period of the certificate.\u003cbr/\u003eThis parameter sets the “Not After” date for the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertificate validity is the period of time during which a certificate is\u003cbr/\u003evalid. Validity can be expressed as an explicit date and time when the certificate\u003cbr/\u003eexpires, or as a span of time after issuance, stated in days, months, or\u003cbr/\u003eyears. For more information, see Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5)\u003cbr/\u003ein RFC 5280.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is unaffected when ValidityNotBefore is also specified. For example,\u003cbr/\u003eif Validity is set to 20 days in the future, the certificate will expire\u003cbr/\u003e20 days from issuance time regardless of the ValidityNotBefore value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe end of the validity period configured on a certificate must not exceed\u003cbr/\u003ethe limit set on its parents in the CA hierarchy. |\n| **validity.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **validity.value**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **validityNotBefore**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eInformation describing the start of the validity period of the certificate.\u003cbr/\u003eThis parameter sets the “Not Before\u0026quot; date for the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, when issuing a certificate, Amazon Web Services Private CA sets\u003cbr/\u003ethe \u0026ldquo;Not Before\u0026rdquo; date to the issuance time minus 60 minutes. This compensates\u003cbr/\u003efor clock inconsistencies across computer systems. The ValidityNotBefore\u003cbr/\u003eparameter can be used to customize the “Not Before” value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnlike the Validity parameter, the ValidityNotBefore parameter is optional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe ValidityNotBefore value is expressed as an explicit date and time, using\u003cbr/\u003ethe Validity type value ABSOLUTE. For more information, see Validity (https://docs.aws.amazon.com/privateca/latest/APIReference/API_Validity.html)\u003cbr/\u003ein this API reference and Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5)\u003cbr/\u003ein RFC 5280. |\n| **validityNotBefore.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **validityNotBefore.value**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:67,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificateauthority/",title:"CertificateAuthority",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#CertificateAuthority"\u003eacmpca-controller/apis/v1alpha1#CertificateAuthority\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthority\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorities\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthority\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about your private certificate authority (CA). Your\nprivate CA can issue and revoke X.509 digital certificates. Digital certificates\nverify that the entity named in the certificate Subject field owns or controls\nthe public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html)\naction to create your private CA. You must then call the GetCertificateAuthorityCertificate\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html)\naction to retrieve a private CA certificate signing request (CSR). Sign the\nCSR with your Amazon Web Services Private CA-hosted or on-premises root or\nsubordinate CA certificate. Call the ImportCertificateAuthorityCertificate\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html)\naction to import the signed certificate into Certificate Manager (ACM).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificateAuthorityConfiguration: \n csrExtensions: \n keyUsage: \n crlSign: boolean\n dataEncipherment: boolean\n decipherOnly: boolean\n digitalSignature: boolean\n encipherOnly: boolean\n keyAgreement: boolean\n keyCertSign: boolean\n keyEncipherment: boolean\n nonRepudiation: boolean\n subjectInformationAccess:\n accessLocation: \n directoryName: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\n dnsName: string\n ediPartyName: \n nameAssigner: string\n partyName: string\n ipAddress: string\n otherName: \n typeID: string\n value: string\n registeredID: string\n rfc822Name: string\n uniformResourceIdentifier: string\n accessMethod: \n accessMethodType: string\n customObjectIdentifier: string\n keyAlgorithm: string\n signingAlgorithm: string\n subject: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\ncertificateAuthorityType: string\nkeyStorageSecurityStandard: string\nrevocationConfiguration: \n crlConfiguration: \n customCNAME: string\n enabled: boolean\n expirationInDays: integer\n s3BucketName: string\n s3ObjectACL: string\n ocspConfiguration: \n enabled: boolean\n ocspCustomCNAME: string\ntags:\n- key: string\n value: string\nusageMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eName and bit size of the private key algorithm, the name of the signing algorithm,\u003cbr/\u003eand X.500 certificate subject information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the certificate extensions to be added to the certificate signing\u003cbr/\u003erequest (CSR).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines one or more purposes for which the key contained in the certificate\u003cbr/\u003ecan be used. Default value for each option is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.crlSign\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.dataEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.decipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.digitalSignature\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.encipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyAgreement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyCertSign\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.nonRepudiation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides access information used by the authorityInfoAccess and subjectInfoAccess\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eextensions described in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.commonName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.country\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.givenName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.initials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.locality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.organization\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.surname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.title\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Electronic Data Interchange (EDI) entity as described in as\u003cbr/\u003edefined in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280)\u003cbr/\u003ein RFC 5280.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName.nameAssigner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName.partyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a custom ASN.1 X.400 GeneralName using an object identifier (OID)\u003cbr/\u003eand value. The OID must satisfy the regular expression shown below. For more\u003cbr/\u003einformation, see NIST\u0026rsquo;s definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName.typeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.registeredID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.rfc822Name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.uniformResourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the type and format of extension access. Only one of CustomObjectIdentifier\u003cbr/\u003eor AccessMethodType may be provided. Providing both results in InvalidArgsException.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod.accessMethodType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod.customObjectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.keyAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.signingAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.commonName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.country\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.givenName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.initials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.locality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.organization\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.surname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.title\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of the certificate authority.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyStorageSecurityStandard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies a cryptographic key management compliance standard used for handling\u003cbr/\u003eCA keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: FIPS_140_2_LEVEL_3_OR_HIGHER\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSome Amazon Web Services Regions do not support the default. When creating\u003cbr/\u003ea CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the\u003cbr/\u003eargument for KeyStorageSecurityStandard. Failure to do this results in an\u003cbr/\u003eInvalidArgsException with the message, \u0026ldquo;A certificate authority cannot be\u003cbr/\u003ecreated in this region with the specified security standard.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about security standard support in various Regions, see Storage\u003cbr/\u003eand security compliance of Amazon Web Services Private CA private keys (https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information to enable Online Certificate Status Protocol (OCSP)\u003cbr/\u003esupport, to enable a certificate revocation list (CRL), to enable both, or\u003cbr/\u003eto enable neither. The default is for both certificate validation mechanisms\u003cbr/\u003eto be disabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following requirements apply to revocation configurations.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration disabling CRLs or OCSP must contain only the Enabled=False\u003cbr/\u003e parameter, and will fail if other parameters such as CustomCname or ExpirationInDays\u003cbr/\u003e are included.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * In a CRL configuration, the S3BucketName parameter must conform to Amazon\u003cbr/\u003e S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration containing a custom Canonical Name (CNAME) parameter\u003cbr/\u003e for CRLs or OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt)\u003cbr/\u003e restrictions on the use of special characters in a CNAME.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * In a CRL or OCSP configuration, the value of a CNAME parameter must\u003cbr/\u003e not include a protocol prefix such as \u0026ldquo;http://\u0026rdquo; or \u0026ldquo;https://\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see the OcspConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html)\u003cbr/\u003eand CrlConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html)\u003cbr/\u003etypes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information for a certificate revocation list (CRL).\u003cbr/\u003eYour private certificate authority (CA) creates base CRLs. Delta CRLs are\u003cbr/\u003enot supported. You can enable CRLs for your new or an existing private CA\u003cbr/\u003eby setting the Enabled parameter to true. Your private CA writes CRLs to\u003cbr/\u003ean S3 bucket that you specify in the S3BucketName parameter. You can hide\u003cbr/\u003ethe name of your bucket by specifying a value for the CustomCname parameter.\u003cbr/\u003eYour private CA copies the CNAME or the S3 bucket name to the CRL Distribution\u003cbr/\u003ePoints extension of each certificate it issues. Your S3 bucket policy must\u003cbr/\u003egive write permission to Amazon Web Services Private CA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Web Services Private CA assets that are stored in Amazon S3 can be\u003cbr/\u003eprotected with encryption. For more information, see Encrypting Your CRLs\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour private CA uses the value in the ExpirationInDays parameter to calculate\u003cbr/\u003ethe nextUpdate field in the CRL. The CRL is refreshed prior to a certificate\u0026rsquo;s\u003cbr/\u003eexpiration date or when a certificate is revoked. When a certificate is revoked,\u003cbr/\u003eit appears in the CRL until the certificate expires, and then in one additional\u003cbr/\u003eCRL after expiration, and it always appears in the audit report.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA CRL is typically updated approximately 30 minutes after a certificate is\u003cbr/\u003erevoked. If for any reason a CRL update fails, Amazon Web Services Private\u003cbr/\u003eCA makes further attempts every 15 minutes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCRLs contain the following fields:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Version: The current version number defined in RFC 5280 is V2. The integer\u003cbr/\u003e value is 0x1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Algorithm: The name of the algorithm used to sign the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Issuer: The X.500 distinguished name of your private CA that issued\u003cbr/\u003e the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Last Update: The issue date and time of this CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Next Update: The day and time by which the next CRL will be issued.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Revoked Certificates: List of revoked certificates. Each list item contains\u003cbr/\u003e the following information. Serial Number: The serial number, in hexadecimal\u003cbr/\u003e format, of the revoked certificate. Revocation Date: Date and time the\u003cbr/\u003e certificate was revoked. CRL Entry Extensions: Optional extensions for\u003cbr/\u003e the CRL entry. X509v3 CRL Reason Code: Reason the certificate was revoked.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CRL Extensions: Optional extensions for the CRL. X509v3 Authority Key\u003cbr/\u003e Identifier: Identifies the public key associated with the private key\u003cbr/\u003e used to sign the certificate. X509v3 CRL Number:: Decimal sequence number\u003cbr/\u003e for the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Algorithm: Algorithm used by your private CA to sign the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Value: Signature computed over the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertificate revocation lists created by Amazon Web Services Private CA are\u003cbr/\u003eDER-encoded. You can use the following OpenSSL command to list a CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl crl -inform DER -text -in crl_path -noout\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Planning a certificate revocation list (CRL) (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html)\u003cbr/\u003ein the Amazon Web Services Private Certificate Authority User Guide\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.customCNAME\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.expirationInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.s3BucketName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.s3ObjectACL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information to enable and configure Online Certificate Status Protocol\u003cbr/\u003e(OCSP) for validating certificate revocation status.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you revoke a certificate, OCSP responses may take up to 60 minutes to\u003cbr/\u003ereflect the new status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration.ocspCustomCNAME\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eKey-value pairs that will be attached to the new private CA. You can associate\u003cbr/\u003eup to 50 tags with a private CA. For information using tags with IAM to manage\u003cbr/\u003epermissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are labels that you can use to identify and organize your private CAs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEach tag consists of a key and an optional value. You can associate up to\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e50 tags with a private CA. To add one or more tags to a private CA, call\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe TagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaction. To remove a tag, call the UntagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaction.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the CA issues general-purpose certificates that typically\u003cbr/\u003erequire a revocation mechanism, or short-lived certificates that may optionally\u003cbr/\u003eomit revocation because they expire quickly. Short-lived certificate validity\u003cbr/\u003eis limited to seven days.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is GENERAL_PURPOSE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncsr: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecsr\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:68,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificateauthorityactivation/",title:"CertificateAuthorityActivation",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#CertificateAuthorityActivation"\u003eacmpca-controller/apis/v1alpha1#CertificateAuthorityActivation\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityActivation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityActivationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorityactivations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorityactivation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificate: \n key: string\n name: string\n namespace: string\ncertificateAuthorityARN: string\ncertificateAuthorityRef: \n from: \n name: string\ncertificateChain: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html).\u003cbr/\u003eThis must be of the form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateChain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA PEM-encoded file that contains all of your certificates, other than the\u003cbr/\u003ecertificate you\u0026rsquo;re importing, chaining up to your root CA. Your Amazon Web\u003cbr/\u003eServices Private CA-hosted or on-premises root certificate is the last in\u003cbr/\u003ethe chain, and each certificate in the chain signs the one preceding.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter must be supplied when you import a subordinate CA. When you\u003cbr/\u003eimport a root CA, there is no chain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:69,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#Cluster"\u003eecs-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA regional grouping of one or more container instances where you can run\ntask requests. Each account receives a default cluster the first time you\nuse the Amazon ECS service, but you may also create other clusters. Clusters\nmay contain more than one instance type simultaneously.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacityProviders:\n- string\nconfiguration: \n executeCommandConfiguration: \n kmsKeyID: string\n logConfiguration: \n cloudWatchEncryptionEnabled: boolean\n cloudWatchLogGroupName: string\n s3BucketName: string\n s3EncryptionEnabled: boolean\n s3KeyPrefix: string\n logging: string\ndefaultCapacityProviderStrategy:\n- base: integer\n capacityProvider: string\n weight: integer\nname: string\nserviceConnectDefaults: \n namespace: string\nsettings:\n- name: string\n value: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe short name of one or more capacity providers to associate with the cluster.\u003cbr/\u003eA capacity provider must be associated with a cluster before it can be included\u003cbr/\u003eas part of the default capacity provider strategy of the cluster or used\u003cbr/\u003ein a capacity provider strategy when calling the CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)\u003cbr/\u003eor RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)\u003cbr/\u003eactions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\u003cbr/\u003eprovider must be created but not associated with another cluster. New Auto\u003cbr/\u003eScaling group capacity providers can be created with the CreateCapacityProvider\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html)\u003cbr/\u003eAPI operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\u003cbr/\u003ecapacity providers. The Fargate capacity providers are available to all accounts\u003cbr/\u003eand only need to be associated with a cluster to be used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe PutCapacityProvider (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html)\u003cbr/\u003eAPI operation is used to update the list of available capacity providers\u003cbr/\u003efor a cluster after the cluster is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the execute command configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the results of the execute command actions. The\u003cbr/\u003elogs can be sent to CloudWatch Logs or an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.cloudWatchEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.cloudWatchLogGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3BucketName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3EncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3KeyPrefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultCapacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe capacity provider strategy to set as the default for the cluster. After\u003cbr/\u003ea default capacity provider strategy is set for a cluster, when you call\u003cbr/\u003ethe CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)\u003cbr/\u003eor RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)\u003cbr/\u003eAPIs with no capacity provider strategy or launch type specified, the default\u003cbr/\u003ecapacity provider strategy for the cluster is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a default capacity provider strategy isn\u0026rsquo;t defined for a cluster when\u003cbr/\u003eit was created, it can be defined later with the PutClusterCapacityProviders\u003cbr/\u003eAPI operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultCapacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003edefaultCapacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edefaultCapacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edefaultCapacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster. If you don\u0026rsquo;t specify a name for your cluster, you\u003cbr/\u003ecreate a cluster that\u0026rsquo;s named default. Up to 255 letters (uppercase and lowercase),\u003cbr/\u003enumbers, underscores, and hyphens are allowed. |\n| \u003cstrong\u003eserviceConnectDefaults\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUse this parameter to set a default Service Connect namespace. After you\u003cbr/\u003eset a default Service Connect namespace, any new services with Service Connect\u003cbr/\u003eturned on that are created in the cluster are added as client services in\u003cbr/\u003ethe namespace. This setting only applies to new services that set the enabled\u003cbr/\u003eparameter to true in the ServiceConnectConfiguration. You can set the namespace\u003cbr/\u003eof each service individually in the ServiceConnectConfiguration to override\u003cbr/\u003ethis default parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eserviceConnectDefaults.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe setting to use when creating a cluster. This parameter is used to turn\u003cbr/\u003eon CloudWatch Container Insights for a cluster. If this value is specified,\u003cbr/\u003eit overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. |\n| \u003cstrong\u003esettings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings to use when creating a cluster. This parameter is used to turn\non CloudWatch Container Insights for a cluster. || \u003cstrong\u003esettings.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esettings.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the cluster to help you categorize and organize\u003cbr/\u003ethem. Each tag consists of a key and an optional value. You define both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactiveServicesCount: integer\nattachments:\n details:\n - name: string\n value: string\n id: string\n status: string\n type: string\nattachmentsStatus: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\npendingTasksCount: integer\nregisteredContainerInstancesCount: integer\nrunningTasksCount: integer\nstatistics:\n- name: string\n value: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveServicesCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of services that are running on the cluster in an ACTIVE state.\u003cbr/\u003eYou can view these services with ListServices.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe resources attached to a cluster. When using a capacity provider with\u003cbr/\u003ea cluster, the capacity provider and associated resources are returned as\u003cbr/\u003ecluster attachments.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container instance or task attachment.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].details.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].details.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachmentsStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the capacity providers associated with the cluster. The following\u003cbr/\u003eare the states that are returned.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_IN_PROGRESS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe available capacity providers for the cluster are updating.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_COMPLETE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe capacity providers have successfully updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_FAILED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe capacity provider updates failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingTasksCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the PENDING state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredContainerInstancesCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of container instances registered into the cluster. This includes\u003cbr/\u003econtainer instances in both ACTIVE and DRAINING status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erunningTasksCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the RUNNING state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAdditional information about your clusters that are separated by launch type.\u003cbr/\u003eThey include the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * runningEC2TasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RunningFargateTasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pendingEC2TasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pendingFargateTasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * activeEC2ServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * activeFargateServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * drainingEC2ServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * drainingFargateServiceCount\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the cluster. The following are the possible states that are\u003cbr/\u003ereturned.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eACTIVE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster is ready to accept tasks and if applicable you can register container\u003cbr/\u003einstances with the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePROVISIONING\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider are being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDEPROVISIONING\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider are being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFAILED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider have failed to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eINACTIVE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has been deleted. Clusters with an INACTIVE status may remain\u003cbr/\u003ediscoverable in your account for a period of time. However, this behavior\u003cbr/\u003eis subject to change in the future. We don\u0026rsquo;t recommend that you rely on INACTIVE\u003cbr/\u003eclusters persisting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:70,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Cluster"\u003eeks-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Amazon EKS cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessConfig: \n authenticationMode: string\n bootstrapClusterCreatorAdminPermissions: boolean\nclientRequestToken: string\nencryptionConfig:\n provider: \n keyARN: string\n keyRef: \n from: \n name: string\n resources:\n - string\nkubernetesNetworkConfig: \n ipFamily: string\n serviceIPv4CIDR: string\nlogging: \n clusterLogging:\n - enabled: boolean\n types:\n - string\nname: string\noutpostConfig: \n controlPlaneInstanceType: string\n controlPlanePlacement: \n groupName: string\n outpostARNs:\n - string\nresourcesVPCConfig: \n endpointPrivateAccess: boolean\n endpointPublicAccess: boolean\n publicAccessCIDRs:\n - string\n securityGroupIDs:\n - string\n securityGroupRefs:\n from: \n name: string\n subnetIDs:\n - string\n subnetRefs:\n from: \n name: string\nroleARN: string\nroleRef: \n from: \n name: string\ntags: {}\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig.authenticationMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig.bootstrapClusterCreatorAdminPermissions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for KeyARN\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].resources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].resources.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesNetworkConfig.ipFamily\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesNetworkConfig.serviceIPv4CIDR\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnable or disable exporting the Kubernetes control plane logs for your cluster\u003cbr/\u003eto CloudWatch Logs. By default, cluster control plane logs aren\u0026rsquo;t exported\u003cbr/\u003eto CloudWatch Logs. For more information, see Amazon EKS Cluster control\u003cbr/\u003eplane logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)\u003cbr/\u003ein the Amazon EKS User Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCloudWatch Logs ingestion, archive storage, and data scanning rates apply\u003cbr/\u003eto exported control plane logs. For more information, see CloudWatch Pricing\u003cbr/\u003e(http://aws.amazon.com/cloudwatch/pricing/).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the enabled or disabled Kubernetes control plane logs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor your cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[].types\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[].types.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the configuration of your local Amazon EKS cluster\u003cbr/\u003eon an Amazon Web Services Outpost. Before creating a local cluster on an\u003cbr/\u003eOutpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts\u003cbr/\u003e(https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html)\u003cbr/\u003ein the Amazon EKS User Guide. This object isn\u0026rsquo;t available for creating Amazon\u003cbr/\u003eEKS clusters on the Amazon Web Services cloud.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlaneInstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlanePlacement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe placement configuration for all the control plane instances of your local\u003cbr/\u003eAmazon EKS cluster on an Amazon Web Services Outpost. For more information,\u003cbr/\u003esee Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlanePlacement.groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.outpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.outpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.endpointPrivateAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.endpointPublicAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.publicAccessCIDRs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.publicAccessCIDRs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.securityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **resourcesVPCConfig.securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eresourcesVPCConfig.securityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eresourcesVPCConfig.subnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eresourcesVPCConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eresourcesVPCConfig.subnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetIDs |\n| \u003cstrong\u003eresourcesVPCConfig.subnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **resourcesVPCConfig.subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eresourcesVPCConfig.subnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that provides permissions\u003cbr/\u003efor the Kubernetes control plane to make calls to Amazon Web Services API\u003cbr/\u003eoperations on your behalf. For more information, see Amazon EKS Service IAM\u003cbr/\u003eRole (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html)\u003cbr/\u003ein the Amazon EKS User Guide . |\n| \u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\n| \u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe desired Kubernetes version for your cluster. If you don\u0026rsquo;t specify a value\u003cbr/\u003ehere, the default version available in Amazon EKS is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default version might not be the latest version available. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncertificateAuthority: \n data: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconnectorConfig: \n activationCode: string\n activationExpiry: string\n activationID: string\n provider: string\n roleARN: string\ncreatedAt: string\nendpoint: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nid: string\nidentity: \n oidc: \n issuer: string\nplatformVersion: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe certificate-authority-data for your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthority.data\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration used to connect to a cluster for registration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationExpiry\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.provider\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint for your Kubernetes API server.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the health of your local Amazon EKS cluster on an\u003cbr/\u003eAmazon Web Services Outpost. This object isn\u0026rsquo;t available for clusters on\u003cbr/\u003ethe Amazon Web Services cloud.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eYou can\u0026rsquo;t use this API with an Amazon EKS cluster on the Amazon Web Services\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecloud.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe identity provider information for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity.oidc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the OpenID Connect (https://openid.net/connect/) (OIDC)\u003cbr/\u003eidentity provider information for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity.oidc.issuer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform version of your Amazon EKS cluster. For more information about\u003cbr/\u003eclusters deployed on the Amazon Web Services Cloud, see Platform versions\u003cbr/\u003e(https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide . For more information about local clusters\u003cbr/\u003edeployed on an Outpost, see Amazon EKS local cluster platform versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide .\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:71,href:"https://aws-controllers-k8s.github.io/community/reference/kafka/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003ekafka.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kafka-controller/apis/v1alpha1#Cluster"\u003ekafka-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eReturns information about a cluster of either the provisioned or the serverless\ntype.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebrokerNodeGroupInfo: \n brokerAZDistribution: string\n clientSubnets:\n - string\n connectivityInfo: \n publicAccess: \n type_: string\n instanceType: string\n securityGroups:\n - string\n storageInfo: \n ebsStorageInfo: \n provisionedThroughput: \n enabled: boolean\n volumeThroughput: integer\n volumeSize: integer\nclientAuthentication: \n sasl: \n iam: \n enabled: boolean\n scram: \n enabled: boolean\n tls: \n certificateAuthorityARNList:\n - string\n enabled: boolean\n unauthenticated: \n enabled: boolean\nconfigurationInfo: \n arn: string\n revision: integer\nencryptionInfo: \n encryptionAtRest: \n dataVolumeKMSKeyID: string\n encryptionInTransit: \n clientBroker: string\n inCluster: boolean\nenhancedMonitoring: string\nkafkaVersion: string\nloggingInfo: \n brokerLogs: \n cloudWatchLogs: \n enabled: boolean\n logGroup: string\n firehose: \n deliveryStream: string\n enabled: boolean\n s3: \n bucket: string\n enabled: boolean\n prefix: string\nname: string\nnumberOfBrokerNodes: integer\nopenMonitoring: \n prometheus: \n jmxExporter: \n enabledInBroker: boolean\n nodeExporter: \n enabledInBroker: boolean\nstorageMode: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.brokerAZDistribution\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution of broker nodes across Availability Zones. By default, broker\u003cbr/\u003enodes are distributed among the Availability Zones of your Region. Currently,\u003cbr/\u003ethe only supported value is DEFAULT. You can either specify this value explicitly\u003cbr/\u003eor leave it out.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.clientSubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.clientSubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.connectivityInfo.publicAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eBroker public access control.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**brokerNodeGroupInfo.connectivityInfo.publicAccess.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the EBS storage volumes attached to Apache Kafka\u003cbr/\u003ebroker nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about provisioned throughput for EBS storage volumes\u003cbr/\u003eattached to kafka broker nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.volumeThroughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIncludes all client authentication related information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.iam\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.iam.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.scram\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.scram.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails for client authentication using TLS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls.certificateAuthorityARNList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls.certificateAuthorityARNList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.unauthenticated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about unauthenticated traffic to the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.unauthenticated.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the configuration that you want MSK to use for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo.revision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIncludes all encryption-related information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionAtRest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data-volume encryption details.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionAtRest.dataVolumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for encrypting data in transit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit.clientBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eClient-broker encryption in transit setting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit.inCluster\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the level of monitoring for the MSK cluster. The possible values\u003cbr/\u003eare DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekafkaVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of Apache Kafka.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eLoggingInfo details.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe broker logs configuration for this MSK cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails of the CloudWatch Logs destination for broker logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFirehose details for BrokerLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the Amazon S3 destination for broker logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfBrokerNodes\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of Apache Kafka broker nodes in the Amazon MSK cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for open monitoring.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003ePrometheus settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.jmxExporter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want to enable or disable the JMX Exporter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.jmxExporter.enabledInBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.nodeExporter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want to enable or disable the Node Exporter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.nodeExporter.enabledInBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis controls storage mode for supported storage tiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCreate tags when creating the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the cluster. The possible states are ACTIVE, CREATING, DELETING,\u003cbr/\u003eFAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:72,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#Cluster"\u003ememorydb-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains all of the attributes of a specific cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaclName: string\naclRef: \n from: \n name: string\nautoMinorVersionUpgrade: boolean\ndescription: string\nengineVersion: string\nkmsKeyID: string\nmaintenanceWindow: string\nname: string\nnodeType: string\nnumReplicasPerShard: integer\nnumShards: integer\nparameterGroupName: string\nparameterGroupRef: \n from: \n name: string\nport: integer\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nsnapshotARNs:\n- string\nsnapshotName: string\nsnapshotRef: \n from: \n name: string\nsnapshotRetentionLimit: integer\nsnapshotWindow: string\nsnsTopicARN: string\nsnsTopicRef: \n from: \n name: string\nsubnetGroupName: string\nsubnetGroupRef: \n from: \n name: string\ntags:\n- key: string\n value: string\ntlsEnabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Access Control List to associate with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhen set to true, the cluster will automatically receive minor engine version upgrades after launch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional description of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the Redis engine to be used for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster. This value must be unique as it also serves as the cluster identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the nodes in the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumReplicasPerShard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of replicas to apply to each shard. The default value is 1. The maximum is 5.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards the cluster will contain. The default value is 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group associated with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which each of the nodes accepts connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of security group names to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. \u003cbr/\u003e Example: 05:00-09:00 \u003cbr/\u003e If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the subnet group to be used for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag to enable in-transit encryption on the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallowedScaleDownNodeTypes:\n- string\nallowedScaleUpNodeTypes:\n- string\navailabilityMode: string\nclusterEndpoint: \n address: string\n port: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nenginePatchVersion: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nnumberOfShards: integer\nparameterGroupStatus: string\npendingUpdates: \n acls: \n aclToApply: string\n resharding: \n slotMigration: \n progressPercentage: number\n serviceUpdates:\n - serviceUpdateName: string\n status: string\nsecurityGroups:\n- securityGroupID: string\n status: string\nshards:\n- name: string\n nodes:\n - availabilityZone: string\n createTime: string\n endpoint: \n address: string\n port: integer\n name: string\n status: string\n numberOfNodes: integer\n slots: string\n status: string\nsnsTopicStatus: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownNodeTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list node types which you can use to scale down your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownNodeTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleUpNodeTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe cluster\u0026rsquo;s configuration endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenginePatchVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Redis engine patch version used by the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards in the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the parameter group used by the cluster, for example \u0026lsquo;active\u0026rsquo; or \u0026lsquo;applying\u0026rsquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA group of settings that are currently being applied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.acls\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the ACL update\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.acls.aclToApply\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the online resharding\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding.slotMigration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the progress of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding.slotMigration.progressPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUpdate action that has yet to be processed for the corresponding apply/stop request\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of security groups used by the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single security group and its status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of shards that are members of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an individual node within a cluster. Each node runs its own instance of the cluster\u0026rsquo;s protocol-compliant caching software.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].createTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to the cluster and its nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].numberOfNodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SNS topic must be in Active status to receive notifications\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the cluster. For example, Available, Updating, Creating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:73,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/codesigningconfig/",title:"CodeSigningConfig",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#CodeSigningConfig"\u003elambda-controller/apis/v1alpha1#CodeSigningConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCodeSigningConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCodeSigningConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecodesigningconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecodesigningconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails about a Code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallowedPublishers: \n signingProfileVersionARNs:\n - string\ncodeSigningPolicies: \n untrustedArtifactOnDeployment: string\ndescription: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSigning profiles for this code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers.signingProfileVersionARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers.signingProfileVersionARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningPolicies.untrustedArtifactOnDeployment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDescriptive name for this code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncodeSigningConfigID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlastModified: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningConfigID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique identifer for the Code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Code signing configuration was last modified,\u003cbr/\u003ein ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:74,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/dataqualityjobdefinition/",title:"DataQualityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#DataQualityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#DataQualityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDataQualityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDataQualityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edataqualityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edataqualityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edataQualityAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n environment: {}\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n recordPreprocessorSourceURI: string\ndataQualityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\n statisticsResource: \n s3URI: string\ndataQualityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\ndataQualityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\njobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the container that runs the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the constraints and baselines for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.statisticsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe statistics resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.statisticsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of inputs for the monitoring job. Currently endpoints are supported\u003cbr/\u003eas monitoring inputs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the monitoring job definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies networking configuration for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:75,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbcluster/",title:"DBCluster",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBCluster"\u003edocumentdb-controller/apis/v1alpha1#DBCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about a cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eavailabilityZones:\n- string\nbackupRetentionPeriod: integer\ndbClusterIdentifier: string\ndbClusterParameterGroupName: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndeletionProtection: boolean\ndestinationRegion: string\nenableCloudwatchLogsExports:\n- string\nengine: string\nengineVersion: string\nglobalClusterIdentifier: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUsername: string\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\nsnapshotIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageType: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon EC2 Availability Zones that instances in the cluster can\u003cbr/\u003ebe created in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: my-cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster parameter group to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA subnet group to associate with this cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mySubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether this cluster can be deleted. If DeletionProtection is enabled,\u003cbr/\u003ethe cluster cannot be deleted unless it is modified and DeletionProtection\u003cbr/\u003eis disabled. DeletionProtection protects clusters from being accidentally\u003cbr/\u003edeleted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that need to be enabled for exporting to Amazon CloudWatch\u003cbr/\u003eLogs. You can enable audit logs or profiler logs. For more information, see\u003cbr/\u003eAuditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)\u003cbr/\u003eand Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use. The \u0026ndash;engine-version will\u003cbr/\u003edefault to the latest major engine version. For production workloads, we\u003cbr/\u003erecommend explicitly declaring this parameter with the intended major engine\u003cbr/\u003eversion.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier of the new global cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key identifier for an encrypted cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\u003cbr/\u003ekey. If you are creating a cluster using the same Amazon Web Services account\u003cbr/\u003ethat owns the KMS encryption key that is used to encrypt the new cluster,\u003cbr/\u003eyou can use the KMS key alias instead of the ARN for the KMS encryption key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an encryption key is not specified in KmsKeyId:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the StorageEncrypted parameter is true, Amazon DocumentDB uses your\u003cbr/\u003e default encryption key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS creates the default encryption key for your Amazon Web Services account.\u003cbr/\u003eYour Amazon Web Services account has a different default encryption key for\u003cbr/\u003eeach Amazon Web Services Regions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master database user. This password can contain any\u003cbr/\u003eprintable ASCII character except forward slash (/), double quote (\u0026quot;), or\u003cbr/\u003ethe \u0026ldquo;at\u0026rdquo; symbol (@).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 100 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the master user for the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be from 1 to 63 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot be a reserved word for the chosen database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the instances in the cluster accept connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNot currently supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled using the BackupRetentionPeriod parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe weekly time range during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the snapshot or cluster snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use either the name or the Amazon Resource Name (ARN) to specify\u003cbr/\u003ea cluster snapshot. However, you can use only the ARN to specify a snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the cluster is encrypted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe storage type to associate with the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information on storage types for Amazon DocumentDB clusters, see Cluster\u003cbr/\u003estorage configurations in the Amazon DocumentDB Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for storage type - standard\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 VPC security groups to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociatedRoles:\n- roleARN: string\n status: string\ncloneGroupID: string\nclusterCreateTime: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndbClusterMembers:\n- dbClusterParameterGroupStatus: string\n dbInstanceIdentifier: string\n isClusterWriter: boolean\n promotionTier: integer\ndbClusterParameterGroup: string\ndbClusterResourceID: string\ndbSubnetGroup: string\nearliestRestorableTime: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: string\nhostedZoneID: string\nlatestRestorableTime: string\nmultiAZ: boolean\npercentProgress: string\nreadReplicaIdentifiers:\n- string\nreaderEndpoint: string\nreplicationSourceIdentifier: string\nstatus: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of the Identity and Access Management (IAM) roles that are\u003cbr/\u003eassociated with the cluster. (IAM) roles that are associated with a cluster\u003cbr/\u003egrant permission for the cluster to access other Amazon Web Services services\u003cbr/\u003eon your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Identity and Access Management (IAM) role that is associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith a cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloneGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the clone group to which the DB cluster is associated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the time when the cluster was created, in Universal Coordinated\u003cbr/\u003eTime (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of instances that make up the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about an instance that is part of a cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].isClusterWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].promotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the cluster parameter group for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the cluster.\u003cbr/\u003eThis identifier is found in CloudTrail log entries whenever the KMS key for\u003cbr/\u003ethe cluster is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group that is associated with the cluster,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this cluster is configured to export to Amazon CloudWatch\u003cbr/\u003eLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the cluster has instances in multiple Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epercentProgress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the progress of the operation as a percentage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the secondary clusters that are associated\u003cbr/\u003ewith this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source cluster if this cluster is a secondary\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of virtual private cloud (VPC) security groups that the cluster\u003cbr/\u003ebelongs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed as a response element for queries on virtual private cloud (VPC) security\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup membership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:76,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbcluster/",title:"DBCluster",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBCluster"\u003erds-controller/apis/v1alpha1#DBCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.\u003c/p\u003e\n\u003cp\u003eFor an Amazon Aurora DB cluster, this data type is used as a response element\nin the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,\nModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,\nRestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.\u003c/p\u003e\n\u003cp\u003eFor a Multi-AZ DB cluster, this data type is used as a response element in\nthe operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,\nModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.\u003c/p\u003e\n\u003cp\u003eFor more information on Amazon Aurora DB clusters, see What is Amazon Aurora?\n(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\nin the Amazon Aurora User Guide.\u003c/p\u003e\n\u003cp\u003eFor more information on Multi-AZ DB clusters, see Multi-AZ deployments with\ntwo readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\nin the Amazon RDS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocatedStorage: integer\nautoMinorVersionUpgrade: boolean\navailabilityZones:\n- string\nbacktrackWindow: integer\nbackupRetentionPeriod: integer\ncharacterSetName: string\ncopyTagsToSnapshot: boolean\ndatabaseName: string\ndbClusterIdentifier: string\ndbClusterInstanceClass: string\ndbClusterParameterGroupName: string\ndbClusterParameterGroupRef: \n from: \n name: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndbSystemID: string\ndeletionProtection: boolean\ndestinationRegion: string\ndomain: string\ndomainIAMRoleName: string\nenableCloudwatchLogsExports:\n- string\nenableGlobalWriteForwarding: boolean\nenableHTTPEndpoint: boolean\nenableIAMDatabaseAuthentication: boolean\nenablePerformanceInsights: boolean\nengine: string\nengineMode: string\nengineVersion: string\nglobalClusterIdentifier: string\niops: integer\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nmanageMasterUserPassword: boolean\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUserSecretKMSKeyID: string\nmasterUserSecretKMSKeyRef: \n from: \n name: string\nmasterUsername: string\nmonitoringInterval: integer\nmonitoringRoleARN: string\nnetworkType: string\noptionGroupName: string\nperformanceInsightsKMSKeyID: string\nperformanceInsightsRetentionPeriod: integer\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\npubliclyAccessible: boolean\nreplicationSourceIdentifier: string\nscalingConfiguration: \n autoPause: boolean\n maxCapacity: integer\n minCapacity: integer\n secondsBeforeTimeout: integer\n secondsUntilAutoPause: integer\n timeoutAction: string\nserverlessV2ScalingConfiguration: \n maxCapacity: number\n minCapacity: number\nsnapshotIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageType: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of storage in gibibytes (GiB) to allocate to each DB instance\u003cbr/\u003ein the Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether minor engine upgrades are applied automatically\u003cbr/\u003eto the DB cluster during the maintenance window. By default, minor engine\u003cbr/\u003eupgrades are applied automatically.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Availability Zones (AZs) where DB instances in the DB cluster can\u003cbr/\u003ebe created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information on Amazon Web Services Regions and Availability Zones, see\u003cbr/\u003eChoosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which automated backups are retained.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be a value from 1 to 35\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echaracterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB cluster should be associated with the\u003cbr/\u003especified CharacterSet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy all tags from the DB cluster to snapshots\u003cbr/\u003eof the DB cluster. The default is not to copy them.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatabaseName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for your database of up to 64 alphanumeric characters. If you do\u003cbr/\u003enot provide a name, Amazon RDS doesn\u0026rsquo;t create a database in the DB cluster\u003cbr/\u003eyou are creating.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB cluster identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: my-cluster1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster,\u003cbr/\u003efor example db.m6gd.xlarge. Not all DB instance classes are available in\u003cbr/\u003eall Amazon Web Services Regions, or for all database engines.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the full list of DB instance classes and availability for your engine,\u003cbr/\u003esee DB instance class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB cluster parameter group to associate with this DB cluster.\u003cbr/\u003eIf you do not specify a value, then the default DB cluster parameter group\u003cbr/\u003efor the specified DB engine and version is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If supplied, must match the name of an existing DB cluster parameter\u003cbr/\u003e group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA DB subnet group to associate with this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eReserved for future use.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster has deletion protection enabled.\u003cbr/\u003eThe database can\u0026rsquo;t be deleted when deletion protection is enabled. By default,\u003cbr/\u003edeletion protection isn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Active Directory directory ID to create the DB cluster in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication\u003cbr/\u003eto authenticate users that connect to the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainIAMRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the name of the IAM role to be used when making API calls to the\u003cbr/\u003eDirectory Service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of log types that need to be enabled for exporting to CloudWatch\u003cbr/\u003eLogs. The values in the list depend on the DB engine being used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are postgresql and upgrade.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible value is postgresql.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about exporting CloudWatch Logs for Amazon RDS, see\u003cbr/\u003ePublishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about exporting CloudWatch Logs for Amazon Aurora, see\u003cbr/\u003ePublishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableHTTPEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable the HTTP endpoint for an Aurora\u003cbr/\u003eServerless v1 DB cluster. By default, the HTTP endpoint is disabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen enabled, the HTTP endpoint provides a connectionless web service API\u003cbr/\u003efor running SQL queries on the Aurora Serverless v1 DB cluster. You can also\u003cbr/\u003equery your database from inside the RDS console with the query editor.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableIAMDatabaseAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts. By default, mapping\u003cbr/\u003eisn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenablePerformanceInsights\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to turn on Performance Insights for the DB\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB engine mode of the DB cluster, either provisioned or serverless.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe serverless engine mode only applies for Aurora Serverless v1 DB clusters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLimitations and requirements apply to some DB engine modes. For more information,\u003cbr/\u003esee the following sections in the Amazon Aurora User Guide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of parallel query (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible)\u003cbr/\u003eand version 3 (MySQL 8.0-compatible), use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine aurora-mysql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can supply either 5.7 or 8.0 to use the default engine version for Aurora\u003cbr/\u003eMySQL version 2 or version 3, respectively.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for Aurora PostgreSQL, use the\u003cbr/\u003efollowing command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine aurora-postgresql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for RDS for MySQL, use the following\u003cbr/\u003ecommand:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine mysql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for RDS for PostgreSQL, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine postgres \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Database engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon Aurora PostgreSQL releases and engine versions\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe global cluster ID of an Aurora cluster that becomes the primary cluster\u003cbr/\u003ein the new global database cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of Provisioned IOPS (input/output operations per second) to be\u003cbr/\u003einitially allocated for each DB instance in the Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about valid IOPS values, see Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must be a multiple between .5 and 50 of the storage amount for\u003cbr/\u003ethe DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for an encrypted DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a KMS key isn\u0026rsquo;t specified in KmsKeyId:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If ReplicationSourceIdentifier identifies an encrypted source, then\u003cbr/\u003e Amazon RDS will use the KMS key used to encrypt the source. Otherwise,\u003cbr/\u003e Amazon RDS will use your default KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier\u003cbr/\u003e isn\u0026rsquo;t specified, then Amazon RDS will use your default KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create a read replica of an encrypted DB cluster in another Amazon\u003cbr/\u003eWeb Services Region, you must set KmsKeyId to a KMS key identifier that is\u003cbr/\u003evalid in the destination Amazon Web Services Region. This KMS key is used\u003cbr/\u003eto encrypt the read replica in that Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanageMasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to manage the master user password with Amazon\u003cbr/\u003eWeb Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide and Password management with Amazon Web Services\u003cbr/\u003eSecrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t manage the master user password with Amazon Web Services Secrets\u003cbr/\u003e Manager if MasterUserPassword is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master database user. This password can contain any\u003cbr/\u003eprintable ASCII character except \u0026ldquo;/\u0026rdquo;, \u0026ldquo;\u0026quot;\u0026rdquo;, or \u0026ldquo;@\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified if ManageMasterUserPassword is turned on.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically\u003cbr/\u003egenerated and managed in Amazon Web Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is valid only if the master user password is managed by RDS\u003cbr/\u003ein Amazon Web Services Secrets Manager for the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager\u003cbr/\u003eKMS key is used to encrypt the secret. If the secret is in a different Amazon\u003cbr/\u003eWeb Services account, then you can\u0026rsquo;t use the aws/secretsmanager KMS key to\u003cbr/\u003eencrypt the secret, and you must use a customer managed KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the master user for the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 16 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a reserved word for the chosen database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe interval, in seconds, between points when Enhanced Monitoring metrics\u003cbr/\u003eare collected for the DB cluster. To turn off collecting Enhanced Monitoring\u003cbr/\u003emetrics, specify 0. The default is 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringRoleArn is specified, also set MonitoringInterval to a value\u003cbr/\u003eother than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0, 1, 5, 10, 15, 30, 60\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send\u003cbr/\u003eEnhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.\u003cbr/\u003eFor information on creating a monitoring role, see Setting up and enabling\u003cbr/\u003eEnhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn\u003cbr/\u003evalue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe network type is determined by the DBSubnetGroup specified for the DB\u003cbr/\u003ecluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and\u003cbr/\u003ethe IPv6 protocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB cluster should be associated with the\u003cbr/\u003especified option group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDB clusters are associated with a default option group that can\u0026rsquo;t be modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for encryption of Performance\u003cbr/\u003eInsights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eRDS uses your default KMS key. There is a default KMS key for your Amazon\u003cbr/\u003eWeb Services account. Your Amazon Web Services account has a different default\u003cbr/\u003eKMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain Performance Insights data. The default is 7\u003cbr/\u003edays. The following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 7\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * month * 31, where month is a number of months from 1-23\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, the following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 93 (3 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 341 (11 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 589 (19 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a retention period such as 94, which isn\u0026rsquo;t a valid value,\u003cbr/\u003eRDS issues an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the instances in the DB cluster accept connections.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL and Aurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL and Aurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 5432\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you are replicating a DB cluster from one Amazon Web Services GovCloud\u003cbr/\u003e(US) Region to another, an URL that contains a Signature Version 4 signed\u003cbr/\u003erequest for the CreateDBCluster operation to be called in the source Amazon\u003cbr/\u003eWeb Services Region where the DB cluster is replicated from. Specify PreSignedUrl\u003cbr/\u003eonly when you are performing cross-Region replication from an encrypted DB\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL must be a valid request for the CreateDBCluster API operation\u003cbr/\u003ethat can run in the source Amazon Web Services Region that contains the encrypted\u003cbr/\u003eDB cluster to copy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL request must contain the following parameter values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt\u003cbr/\u003e the copy of the DB cluster in the destination Amazon Web Services Region.\u003cbr/\u003e This should refer to the same KMS key for both the CreateDBCluster operation\u003cbr/\u003e that is called in the destination Amazon Web Services Region, and the\u003cbr/\u003e operation contained in the presigned URL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DestinationRegion - The name of the Amazon Web Services Region that\u003cbr/\u003e Aurora read replica will be created in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ReplicationSourceIdentifier - The DB cluster identifier for the encrypted\u003cbr/\u003e DB cluster to be copied. This identifier must be in the Amazon Resource\u003cbr/\u003e Name (ARN) format for the source Amazon Web Services Region. For example,\u003cbr/\u003e if you are copying an encrypted DB cluster from the us-west-2 Amazon Web\u003cbr/\u003e Services Region, then your ReplicationSourceIdentifier would look like\u003cbr/\u003e Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn how to generate a Signature Version 4 signed request, see Authenticating\u003cbr/\u003eRequests: Using Query Parameters (Amazon Web Services Signature Version 4)\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)\u003cbr/\u003eand Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\u003cbr/\u003eSourceRegion (or \u0026ndash;source-region for the CLI) instead of specifying PreSignedUrl\u003cbr/\u003emanually. Specifying SourceRegion autogenerates a presigned URL that is a\u003cbr/\u003evalid request for the operation that can run in the source Amazon Web Services\u003cbr/\u003eRegion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled using the BackupRetentionPeriod parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region. To view the time blocks available,\u003cbr/\u003esee Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe weekly time range during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week. To see the time blocks available, see Adjusting the Preferred DB\u003cbr/\u003eCluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster is publicly accessible.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB cluster is publicly accessible, its Domain Name System (DNS)\u003cbr/\u003eendpoint resolves to the private IP address from within the DB cluster\u0026rsquo;s\u003cbr/\u003evirtual private cloud (VPC). It resolves to the public IP address from outside\u003cbr/\u003eof the DB cluster\u0026rsquo;s VPC. Access to the DB cluster is ultimately controlled\u003cbr/\u003eby the security group it uses. That public access isn\u0026rsquo;t permitted if the\u003cbr/\u003esecurity group assigned to the DB cluster doesn\u0026rsquo;t permit it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB cluster isn\u0026rsquo;t publicly accessible, it is an internal DB cluster\u003cbr/\u003ewith a DNS name that resolves to a private IP address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default behavior varies depending on whether DBSubnetGroupName\u003cbr/\u003eis specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName isn\u0026rsquo;t specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB cluster is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region has an internet gateway attached\u003cbr/\u003e to it, the DB cluster is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName is specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB cluster is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that has an internet gateway attached\u003cbr/\u003e to it, the DB cluster is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if\u003cbr/\u003ethis DB cluster is created as a read replica.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor DB clusters in serverless DB engine mode, the scaling properties of the\u003cbr/\u003eDB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.autoPause\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.maxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.minCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.secondsBeforeTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.secondsUntilAutoPause\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.timeoutAction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the scaling configuration of an Aurora Serverless v2 DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration.maxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration.minCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the DB snapshot or DB cluster snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use either the name or the Amazon Resource Name (ARN) to specify\u003cbr/\u003ea DB cluster snapshot. However, you can use only the ARN to specify a DB\u003cbr/\u003esnapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing Snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster is encrypted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage type to be associated with the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: io1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen specified, a value for the Iops parameter is required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: io1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 VPC security groups to associate with this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactivityStreamKMSKeyID: string\nactivityStreamKinesisStreamName: string\nactivityStreamMode: string\nactivityStreamStatus: string\nassociatedRoles:\n- featureName: string\n roleARN: string\n status: string\nautomaticRestartTime: string\nbacktrackConsumedChangeRecords: integer\ncapacity: integer\ncloneGroupID: string\nclusterCreateTime: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncrossAccountClone: boolean\ncustomEndpoints:\n- string\ndbClusterMembers:\n- dbClusterParameterGroupStatus: string\n dbInstanceIdentifier: string\n isClusterWriter: boolean\n promotionTier: integer\ndbClusterOptionGroupMemberships:\n- dbClusterOptionGroupName: string\n status: string\ndbClusterParameterGroup: string\ndbClusterResourceID: string\ndbSubnetGroup: string\ndomainMemberships:\n- domain: string\n fQDN: string\n iamRoleName: string\n status: string\nearliestBacktrackTime: string\nearliestRestorableTime: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: string\nglobalWriteForwardingRequested: boolean\nglobalWriteForwardingStatus: string\nhostedZoneID: string\nhttpEndpointEnabled: boolean\niamDatabaseAuthenticationEnabled: boolean\nlatestRestorableTime: string\nmasterUserSecret: \n kmsKeyID: string\n secretARN: string\n secretStatus: string\nmultiAZ: boolean\npendingModifiedValues: \n allocatedStorage: integer\n backupRetentionPeriod: integer\n dbClusterIdentifier: string\n engineVersion: string\n iamDatabaseAuthenticationEnabled: boolean\n iops: integer\n masterUserPassword: string\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\npercentProgress: string\nperformanceInsightsEnabled: boolean\nreadReplicaIdentifiers:\n- string\nreaderEndpoint: string\nstatus: string\ntagList:\n- key: string\n value: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier used for encrypting messages in\u003cbr/\u003ethe database activity stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKinesisStreamName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon Kinesis data stream used for the database activity\u003cbr/\u003estream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of the database activity stream. Database events such as a change\u003cbr/\u003eor access generate an activity stream event. The database session can handle\u003cbr/\u003ethese events either synchronously or asynchronously.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the database activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of the Amazon Web Services Identity and Access Management\u003cbr/\u003e(IAM) roles that are associated with the DB cluster. IAM roles that are associated\u003cbr/\u003ewith a DB cluster grant permission for the DB cluster to access other Amazon\u003cbr/\u003eWeb Services on your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Amazon Web Services Identity and Access Management (IAM) role\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is associated with a DB cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticRestartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when a stopped DB cluster is restarted automatically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebacktrackConsumedChangeRecords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of change records stored for Backtrack.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current capacity of an Aurora Serverless v1 DB cluster. The capacity\u003cbr/\u003eis 0 (zero) when the cluster is paused.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Aurora Serverless v1, see Using Amazon Aurora\u003cbr/\u003eServerless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloneGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the clone group to which the DB cluster is associated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the time when the DB cluster was created, in Universal Coordinated\u003cbr/\u003eTime (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecrossAccountClone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the DB cluster is a clone of a DB cluster owned by a different\u003cbr/\u003eAmazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomEndpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eIdentifies all custom endpoints associated with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomEndpoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about an instance that is part of a DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].isClusterWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].promotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of option group memberships for this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains status information for a DB cluster option group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the DB cluster parameter group for the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the DB cluster.\u003cbr/\u003eThis identifier is found in Amazon Web Services CloudTrail log entries whenever\u003cbr/\u003ethe KMS key for the DB cluster is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group associated with the DB cluster,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Active Directory Domain membership records associated with the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Active Directory Domain membership record associated with the DB instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].fQDN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].iamRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestBacktrackTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a DB cluster can be backtracked.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this DB cluster is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLog types vary by DB engine. For information about the log types for each\u003cbr/\u003eDB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalWriteForwardingRequested\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether you have requested to enable write forwarding for a secondary\u003cbr/\u003ecluster in an Aurora global database. Because write forwarding takes time\u003cbr/\u003eto enable, check the value of GlobalWriteForwardingStatus to confirm that\u003cbr/\u003ethe request has completed before using the write forwarding feature for this\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalWriteForwardingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a secondary cluster in an Aurora global database has write\u003cbr/\u003eforwarding enabled, not enabled, or is in the process of enabling it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehttpEndpointEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the HTTP endpoint for an Aurora Serverless\u003cbr/\u003ev1 DB cluster is enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen enabled, the HTTP endpoint provides a connectionless web service API\u003cbr/\u003efor running SQL queries on the Aurora Serverless v1 DB cluster. You can also\u003cbr/\u003equery your database from inside the RDS console with the query editor.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the secret managed by RDS in Amazon Web Services Secrets Manager\u003cbr/\u003efor the master user password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide and Password management with Amazon Web Services\u003cbr/\u003eSecrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.secretARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.secretStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the DB cluster has instances in multiple Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA value that specifies that changes to the DB cluster are pending. This element\u003cbr/\u003eis only included when changes are pending. Specific changes are identified\u003cbr/\u003eby subelements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. In other words,\u003cbr/\u003ethese log types are in the process of being activated or deactivated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTrue if Performance Insights is enabled for the DB cluster, and otherwise\u003cbr/\u003efalse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is only for non-Aurora Multi-AZ DB clusters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the read replicas associated with this\u003cbr/\u003eDB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etagList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etagList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etagList.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etagList.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security groups that the DB cluster belongs to. |\n| \u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for queries on VPC security\ngroup membership. || \u003cstrong\u003evpcSecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:77,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbclusterparametergroup/",title:"DBClusterParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBClusterParameterGroup"\u003erds-controller/apis/v1alpha1#DBClusterParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusterparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusterparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB cluster parameter group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBClusterParameterGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterOverrides: {}\nparameters:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB cluster parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB cluster parameter group family name. A DB cluster parameter group\u003cbr/\u003ecan be associated with one and only one DB cluster parameter group family,\u003cbr/\u003eand can be applied only to a DB cluster running a database engine and engine\u003cbr/\u003eversion compatible with that DB cluster parameter group family.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: aurora-postgresql9.6\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mysql8.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: postgres12\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available parameter group families for a DB engine, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine \u003cengine\u003e\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to list all of the available parameter group families for the\u003cbr/\u003eAurora PostgreSQL DB engine, use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe output contains duplicates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the valid DB engine values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB cluster parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not match the name of an existing DB cluster parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is stored as a lowercase string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of parameters in the DB cluster parameter group to modify.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values (for the application method): immediate\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameters.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB cluster parameter group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameterOverrideStatuses:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of parameters for the DB cluster parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameterOverrideStatuses.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:78,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbinstance/",title:"DBInstance",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBInstance"\u003edocumentdb-controller/apis/v1alpha1#DBInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about an instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eautoMinorVersionUpgrade: boolean\navailabilityZone: string\ncaCertificateIdentifier: string\ncopyTagsToSnapshot: boolean\ndbClusterIdentifier: string\ndbInstanceClass: string\ndbInstanceIdentifier: string\nengine: string\nperformanceInsightsEnabled: boolean\nperformanceInsightsKMSKeyID: string\nperformanceInsightsKMSKeyRef: \n from: \n name: string\npreferredMaintenanceWindow: string\npromotionTier: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThis parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does\u003cbr/\u003enot perform minor version upgrades regardless of the value set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon EC2 Availability Zone that the instance is created in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: A random, system-chosen Availability Zone in the endpoint\u0026rsquo;s Amazon\u003cbr/\u003eWeb Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: us-east-1d\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecaCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe CA certificate identifier to use for the DB instance\u0026rsquo;s server certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Updating Your Amazon DocumentDB TLS Certificates\u003cbr/\u003e(https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)\u003cbr/\u003eand Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)\u003cbr/\u003ein the Amazon DocumentDB Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy tags from the DB instance to snapshots\u003cbr/\u003eof the DB instance. By default, tags are not copied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the cluster that the instance will belong to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceClass\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the instance; for example, db.r5.large.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbinstance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid value: docdb\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable Performance Insights for the DB\u003cbr/\u003eInstance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key identifier for encryption of Performance Insights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for\u003cbr/\u003ethe KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eDocumentDB uses your default KMS key. There is a default KMS key for your\u003cbr/\u003eAmazon Web Services account. Your Amazon Web Services account has a different\u003cbr/\u003edefault KMS key for each Amazon Web Services region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time range each week during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epromotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eA value that specifies the order in which an Amazon DocumentDB replica is\u003cbr/\u003epromoted to the primary instance after a failure of the existing primary\u003cbr/\u003einstance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 0-15\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the instance. You can assign up to 10 tags to\u003cbr/\u003ean instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbackupRetentionPeriod: integer\ncertificateDetails: \n cAIdentifier: string\n validTill: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndbInstanceStatus: string\ndbSubnetGroup: \n dbSubnetGroupARN: string\n dbSubnetGroupDescription: string\n dbSubnetGroupName: string\n subnetGroupStatus: string\n subnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetStatus: string\n vpcID: string\ndbiResourceID: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: \n address: string\n hostedZoneID: string\n port: integer\nengineVersion: string\ninstanceCreateTime: string\nkmsKeyID: string\nlatestRestorableTime: string\npendingModifiedValues: \n allocatedStorage: integer\n backupRetentionPeriod: integer\n caCertificateIdentifier: string\n dbInstanceClass: string\n dbInstanceIdentifier: string\n dbSubnetGroupName: string\n engineVersion: string\n iops: integer\n licenseModel: string\n masterUserPassword: string\n multiAZ: boolean\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\n port: integer\n storageType: string\npreferredBackupWindow: string\npubliclyAccessible: boolean\nstatusInfos:\n- message: string\n normal: boolean\n status: string\n statusType: string\nstorageEncrypted: boolean\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the number of days for which automatic snapshots are retained.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the DB instance\u0026rsquo;s server certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.cAIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.validTill\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group that is associated with the instance,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbiResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the instance.\u003cbr/\u003eThis identifier is found in CloudTrail log entries whenever the KMS key for\u003cbr/\u003ethe instance is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this instance is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the database engine version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the date and time that the instance was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf StorageEncrypted is true, the KMS key identifier for the encrypted instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies that changes to the instance are pending. This element is included\u003cbr/\u003eonly when changes are pending. Specific changes are identified by subelements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.caCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.licenseModel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.multiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. These log types\u003cbr/\u003eare in the process of being activated or deactivated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.storageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the daily time range during which automated backups are created\u003cbr/\u003eif automated backups are enabled, as determined by the BackupRetentionPeriod.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eNot supported. Amazon DocumentDB does not currently support public endpoints.\u003cbr/\u003eThe value of PubliclyAccessible is always false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe status of a read replica. If the instance is not a read replica, this\u003cbr/\u003eis blank.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides a list of status information for an instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].normal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].statusType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether or not the instance is encrypted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security group elements that the instance belongs\u003cbr/\u003eto.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed as a response element for queries on virtual private cloud (VPC) security\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup membership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:79,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbinstance/",title:"DBInstance",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBInstance"\u003erds-controller/apis/v1alpha1#DBInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB instance.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the operations CreateDBInstance,\nCreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,\nPromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,\nRestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocatedStorage: integer\nautoMinorVersionUpgrade: boolean\navailabilityZone: string\nbackupRetentionPeriod: integer\nbackupTarget: string\ncaCertificateIdentifier: string\ncharacterSetName: string\ncopyTagsToSnapshot: boolean\ncustomIAMInstanceProfile: string\ndbClusterIdentifier: string\ndbClusterSnapshotIdentifier: string\ndbInstanceClass: string\ndbInstanceIdentifier: string\ndbName: string\ndbParameterGroupName: string\ndbParameterGroupRef: \n from: \n name: string\ndbSnapshotIdentifier: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndeletionProtection: boolean\ndestinationRegion: string\ndomain: string\ndomainIAMRoleName: string\nenableCloudwatchLogsExports:\n- string\nenableCustomerOwnedIP: boolean\nenableIAMDatabaseAuthentication: boolean\nengine: string\nengineVersion: string\niops: integer\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nlicenseModel: string\nmanageMasterUserPassword: boolean\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUserSecretKMSKeyID: string\nmasterUserSecretKMSKeyRef: \n from: \n name: string\nmasterUsername: string\nmaxAllocatedStorage: integer\nmonitoringInterval: integer\nmonitoringRoleARN: string\nmultiAZ: boolean\nncharCharacterSetName: string\nnetworkType: string\noptionGroupName: string\nperformanceInsightsEnabled: boolean\nperformanceInsightsKMSKeyID: string\nperformanceInsightsRetentionPeriod: integer\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\nprocessorFeatures:\n- name: string\n value: string\npromotionTier: integer\npubliclyAccessible: boolean\nreplicaMode: string\nsourceDBInstanceIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageThroughput: integer\nstorageType: string\ntags:\n- key: string\n value: string\ntdeCredentialARN: string\ntdeCredentialPassword: string\ntimezone: string\nuseDefaultProcessorFeatures: boolean\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of storage in gibibytes (GiB) to allocate for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Aurora cluster volumes automatically grow as the amount of\u003cbr/\u003edata in your database increases, though you are only charged for the space\u003cbr/\u003ethat you use in an Aurora cluster volume.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40\u003cbr/\u003e to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536\u003cbr/\u003e for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 10 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions:\u003cbr/\u003e Must be an integer from 20 to 16384. Web and Express editions: Must be\u003cbr/\u003e an integer from 20 to 16384.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Enterprise and Standard editions: Must\u003cbr/\u003e be an integer from 100 to 16384. Web and Express editions: Must be an\u003cbr/\u003e integer from 100 to 16384.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Enterprise and Standard editions: Must\u003cbr/\u003e be an integer from 20 to 1024. Web and Express editions: Must be an integer\u003cbr/\u003e from 20 to 1024.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether minor engine upgrades are applied automatically\u003cbr/\u003eto the DB instance during the maintenance window. By default, minor engine\u003cbr/\u003eupgrades are applied automatically.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade\u003cbr/\u003eto false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Availability Zone (AZ) where the database will be created. For information\u003cbr/\u003eon Amazon Web Services Regions and Availability Zones, see Regions and Availability\u003cbr/\u003eZones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach Aurora DB cluster hosts copies of its storage in three separate Availability\u003cbr/\u003eZones. Specify one of these Availability Zones. Aurora automatically chooses\u003cbr/\u003ean appropriate Availability Zone if you don\u0026rsquo;t specify one.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: A random, system-chosen Availability Zone in the endpoint\u0026rsquo;s Amazon\u003cbr/\u003eWeb Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: us-east-1d\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraint: The AvailabilityZone parameter can\u0026rsquo;t be specified if the DB instance\u003cbr/\u003eis a Multi-AZ deployment. The specified Availability Zone must be in the\u003cbr/\u003esame Amazon Web Services Region as the current endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which automated backups are retained. Setting this\u003cbr/\u003eparameter to a positive number enables backups. Setting this parameter to\u003cbr/\u003e0 disables automated backups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The retention period for automated backups is managed by\u003cbr/\u003ethe DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be a value from 0 to 35\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be set to 0 if the DB instance is a source to read replicas\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be set to 0 for an RDS Custom for Oracle DB instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies where automated backups and manual snapshots are stored.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are outposts (Amazon Web Services Outposts) and region (Amazon\u003cbr/\u003eWeb Services Region). The default is region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with Amazon RDS on Amazon Web Services\u003cbr/\u003eOutposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecaCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the CA certificate identifier to use for the DB instance’s server\u003cbr/\u003ecertificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using SSL/TLS to encrypt a connection to a DB instance\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)\u003cbr/\u003ein the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to\u003cbr/\u003ea DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echaracterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor supported engines, this value indicates that the DB instance should be\u003cbr/\u003eassociated with the specified CharacterSet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. However, if you need to change\u003cbr/\u003ethe character set, you can change it on the database itself.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The character set is managed by the DB cluster. For more\u003cbr/\u003einformation, see CreateDBCluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy tags from the DB instance to snapshots\u003cbr/\u003eof the DB instance. By default, tags are not copied.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting\u003cbr/\u003ethis value for an Aurora DB instance has no effect on the DB cluster setting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomIAMInstanceProfile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance profile associated with the underlying Amazon EC2 instance of\u003cbr/\u003ean RDS Custom DB instance. The instance profile must meet the following requirements:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The profile must exist in your account.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The profile must have an IAM role that Amazon EC2 has permissions to\u003cbr/\u003e assume.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The instance profile name and the associated IAM role name must start\u003cbr/\u003e with the prefix AWSRDSCustom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the list of permissions required for the IAM role, see Configure IAM\u003cbr/\u003eand your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required for RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the DB cluster that the instance will belong to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterSnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore\u003cbr/\u003efrom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing Multi-AZ DB cluster snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified when DBSnapshotIdentifier is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be specified when DBSnapshotIdentifier isn\u0026rsquo;t specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are restoring from a shared manual Multi-AZ DB cluster snapshot,\u003cbr/\u003e the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be the identifier of an Aurora DB cluster snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster\u003cbr/\u003e snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceClass\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the DB instance, for example db.m5.large.\u003cbr/\u003eNot all DB instance classes are available in all Amazon Web Services Regions,\u003cbr/\u003eor for all database engines. For the full list of DB instance classes, and\u003cbr/\u003eavailability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB instance identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbinstance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe meaning of this parameter differs according to the database engine you\u003cbr/\u003euse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, no database is created in the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 64 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, no database is created in the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 64 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, a database named postgres is created in the DB\u003cbr/\u003einstance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 63 letters, numbers, or underscores.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Oracle System ID (SID) of the created DB instance. If you specify null,\u003cbr/\u003ethe default value ORCL is used. You can\u0026rsquo;t specify the string NULL, or any\u003cbr/\u003eother reserved word, for DBName.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: ORCL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be longer than 8 characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for Oracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Oracle System ID (SID) of the created RDS Custom DB instance. If you\u003cbr/\u003edon\u0026rsquo;t specify a value, the default value is ORCL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: ORCL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 8 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Must be null.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Must be null.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the primary DB instance of the Aurora\u003cbr/\u003eMySQL DB cluster is created. If this parameter isn\u0026rsquo;t specified for an Aurora\u003cbr/\u003eMySQL DB cluster, no database is created in the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 64 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the primary DB instance of the Aurora\u003cbr/\u003ePostgreSQL DB cluster is created. If this parameter isn\u0026rsquo;t specified for an\u003cbr/\u003eAurora PostgreSQL DB cluster, a database named postgres is created in the\u003cbr/\u003eDB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 63 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0 to 9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB parameter group to associate with this DB instance. If\u003cbr/\u003eyou do not specify a value, then the default DB parameter group for the specified\u003cbr/\u003eDB engine and version is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must be 1 to 255 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the DB snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing DBSnapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified when DBClusterSnapshotIdentifier is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be specified when DBClusterSnapshotIdentifier isn\u0026rsquo;t specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\u003cbr/\u003e must be the ARN of the shared DB snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA DB subnet group to associate with this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance has deletion protection enabled.\u003cbr/\u003eThe database can\u0026rsquo;t be deleted when deletion protection is enabled. By default,\u003cbr/\u003edeletion protection isn\u0026rsquo;t enabled. For more information, see Deleting a DB\u003cbr/\u003eInstance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. You can enable or disable deletion protection for the DB\u003cbr/\u003ecluster. For more information, see CreateDBCluster. DB instances in a DB\u003cbr/\u003ecluster can be deleted even when deletion protection is enabled for the DB\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Active Directory directory ID to create the DB instance in. Currently,\u003cbr/\u003eonly MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can\u003cbr/\u003ebe created in an Active Directory Domain.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The domain is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainIAMRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the name of the IAM role to be used when making API calls to the\u003cbr/\u003eDirectory Service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The domain is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of log types that need to be enabled for exporting to CloudWatch\u003cbr/\u003eLogs. The values in the list depend on the DB engine. For more information,\u003cbr/\u003esee Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. CloudWatch Logs exports are managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are agent and error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are alert, audit, listener, trace, and oemagent.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are postgresql and upgrade.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableIAMDatabaseAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts. By default, mapping\u003cbr/\u003eisn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see IAM Database Authentication for MySQL and PostgreSQL\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Mapping Amazon Web Services IAM accounts to database accounts\u003cbr/\u003eis managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot every database engine is available for every Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-oracle-ee (for RDS Custom for Oracle instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-ee (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-se (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-web (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mariadb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-se\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ex\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-web\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of valid engine versions, use the DescribeDBEngineVersions operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the database engines and links to information about the\u003cbr/\u003emajor and minor versions that are available with Amazon RDS. Not every database\u003cbr/\u003eengine is available for every Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The version number of the database engine to be used by the\u003cbr/\u003eDB instance is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for Oracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA custom engine version (CEV) that you have previously created. This setting\u003cbr/\u003eis required for RDS Custom for Oracle. The CEV name has the following format:\u003cbr/\u003e19.customized_string. A valid CEV name is 19.my_cev1. For more information,\u003cbr/\u003esee Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSee RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of Provisioned IOPS (input/output operations per second) to be\u003cbr/\u003einitially allocated for the DB instance. For information about valid IOPS\u003cbr/\u003evalues, see Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must\u003cbr/\u003ebe a multiple between .5 and 50 of the storage amount for the DB instance.\u003cbr/\u003eFor SQL Server DB instances, must be a multiple between 1 and 50 of the storage\u003cbr/\u003eamount for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for an encrypted DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The Amazon Web Services KMS key identifier is managed by\u003cbr/\u003ethe DB cluster. For more information, see CreateDBCluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId\u003cbr/\u003eparameter, then Amazon RDS uses your default KMS key. There is a default\u003cbr/\u003eKMS key for your Amazon Web Services account. Your Amazon Web Services account\u003cbr/\u003ehas a different default KMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA KMS key is required for RDS Custom instances. For most RDS engines, if\u003cbr/\u003eyou leave this parameter empty while enabling StorageEncrypted, the engine\u003cbr/\u003euses the default KMS key. However, RDS Custom doesn\u0026rsquo;t use the default key\u003cbr/\u003ewhen this parameter is empty. You must explicitly specify a key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseModel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLicense model information for this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: license-included\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanageMasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to manage the master user password with Amazon\u003cbr/\u003eWeb Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t manage the master user password with Amazon Web Services Secrets\u003cbr/\u003e Manager if MasterUserPassword is specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master user. The password can include any printable\u003cbr/\u003eASCII character except \u0026ldquo;/\u0026rdquo;, \u0026ldquo;\u0026quot;\u0026rdquo;, or \u0026ldquo;@\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The password for the master user is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Can\u0026rsquo;t be specified if ManageMasterUserPassword is turned on.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 128 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 30 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 128 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically\u003cbr/\u003egenerated and managed in Amazon Web Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is valid only if the master user password is managed by RDS\u003cbr/\u003ein Amazon Web Services Secrets Manager for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager\u003cbr/\u003eKMS key is used to encrypt the secret. If the secret is in a different Amazon\u003cbr/\u003eWeb Services account, then you can\u0026rsquo;t use the aws/secretsmanager KMS key to\u003cbr/\u003eencrypt the secret, and you must use a customer managed KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the master user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The name for the master user is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 16 letters, numbers, or underscores.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a reserved word for the chosen database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxAllocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically\u003cbr/\u003escale the storage of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about this setting, including limitations that apply\u003cbr/\u003eto it, see Managing capacity automatically with Amazon RDS storage autoscaling\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe interval, in seconds, between points when Enhanced Monitoring metrics\u003cbr/\u003eare collected for the DB instance. To disable collection of Enhanced Monitoring\u003cbr/\u003emetrics, specify 0. The default is 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringRoleArn is specified, then you must set MonitoringInterval to\u003cbr/\u003ea value other than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0, 1, 5, 10, 15, 30, 60\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics\u003cbr/\u003eto Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.\u003cbr/\u003eFor information on creating a monitoring role, see Setting Up and Enabling\u003cbr/\u003eEnhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringInterval is set to a value other than 0, then you must supply\u003cbr/\u003ea MonitoringRoleArn value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is a Multi-AZ deployment.\u003cbr/\u003eYou can\u0026rsquo;t set the AvailabilityZone parameter if the DB instance is a Multi-AZ\u003cbr/\u003edeployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. DB instance Availability Zones (AZs) are managed by the DB\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003encharCharacterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the NCHAR character set for the Oracle DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe network type is determined by the DBSubnetGroup specified for the DB\u003cbr/\u003einstance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4\u003cbr/\u003eand the IPv6 protocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB instance should be associated with the\u003cbr/\u003especified option group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePermanent options, such as the TDE option for Oracle Advanced Security TDE,\u003cbr/\u003ecan\u0026rsquo;t be removed from an option group. Also, that option group can\u0026rsquo;t be removed\u003cbr/\u003efrom a DB instance after it is associated with a DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable Performance Insights for the DB\u003cbr/\u003einstance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for encryption of Performance\u003cbr/\u003eInsights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eRDS uses your default KMS key. There is a default KMS key for your Amazon\u003cbr/\u003eWeb Services account. Your Amazon Web Services account has a different default\u003cbr/\u003eKMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain Performance Insights data. The default is 7\u003cbr/\u003edays. The following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 7\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * month * 31, where month is a number of months from 1-23\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, the following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 93 (3 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 341 (11 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 589 (19 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a retention period such as 94, which isn\u0026rsquo;t a valid value,\u003cbr/\u003eRDS issues an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the database accepts connections.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 5432\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1521\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1433\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and\u003cbr/\u003e49152-49156.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you are creating a read replica from one Amazon Web Services GovCloud\u003cbr/\u003e(US) Region to another or from one China Amazon Web Services Region to another,\u003cbr/\u003ethe URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica\u003cbr/\u003eAPI operation in the source Amazon Web Services Region that contains the\u003cbr/\u003esource DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only to Amazon Web Services GovCloud (US) Regions and\u003cbr/\u003eChina Amazon Web Services Regions. It\u0026rsquo;s ignored in other Amazon Web Services\u003cbr/\u003eRegions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only when replicating from a source DB instance. Source\u003cbr/\u003eDB clusters aren\u0026rsquo;t supported in Amazon Web Services GovCloud (US) Regions\u003cbr/\u003eand China Amazon Web Services Regions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must specify this parameter when you create an encrypted read replica\u003cbr/\u003efrom another Amazon Web Services Region by using the Amazon RDS API. Don\u0026rsquo;t\u003cbr/\u003especify PreSignedUrl when you are creating an encrypted read replica in the\u003cbr/\u003esame Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL must be a valid request for the CreateDBInstanceReadReplica\u003cbr/\u003eAPI operation that can run in the source Amazon Web Services Region that\u003cbr/\u003econtains the encrypted source DB instance. The presigned URL request must\u003cbr/\u003econtain the following parameter values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DestinationRegion - The Amazon Web Services Region that the encrypted\u003cbr/\u003e read replica is created in. This Amazon Web Services Region is the same\u003cbr/\u003e one where the CreateDBInstanceReadReplica operation is called that contains\u003cbr/\u003e this presigned URL. For example, if you create an encrypted DB instance\u003cbr/\u003e in the us-west-1 Amazon Web Services Region, from a source DB instance\u003cbr/\u003e in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica\u003cbr/\u003e operation in the us-east-1 Amazon Web Services Region and provide a presigned\u003cbr/\u003e URL that contains a call to the CreateDBInstanceReadReplica operation\u003cbr/\u003e in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion\u003cbr/\u003e in the presigned URL must be set to the us-east-1 Amazon Web Services\u003cbr/\u003e Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KmsKeyId - The KMS key identifier for the key to use to encrypt the\u003cbr/\u003e read replica in the destination Amazon Web Services Region. This is the\u003cbr/\u003e same identifier for both the CreateDBInstanceReadReplica operation that\u003cbr/\u003e is called in the destination Amazon Web Services Region, and the operation\u003cbr/\u003e contained in the presigned URL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SourceDBInstanceIdentifier - The DB instance identifier for the encrypted\u003cbr/\u003e DB instance to be replicated. This identifier must be in the Amazon Resource\u003cbr/\u003e Name (ARN) format for the source Amazon Web Services Region. For example,\u003cbr/\u003e if you are creating an encrypted read replica from a DB instance in the\u003cbr/\u003e us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier\u003cbr/\u003e looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn how to generate a Signature Version 4 signed request, see Authenticating\u003cbr/\u003eRequests: Using Query Parameters (Amazon Web Services Signature Version 4)\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)\u003cbr/\u003eand Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\u003cbr/\u003eSourceRegion (or \u0026ndash;source-region for the CLI) instead of specifying PreSignedUrl\u003cbr/\u003emanually. Specifying SourceRegion autogenerates a presigned URL that is a\u003cbr/\u003evalid request for the operation that can run in the source Amazon Web Services\u003cbr/\u003eRegion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSourceRegion isn\u0026rsquo;t supported for SQL Server, because Amazon RDS for SQL Server\u003cbr/\u003edoesn\u0026rsquo;t support cross-Region read replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled, using the BackupRetentionPeriod parameter. The default\u003cbr/\u003eis a 30-minute window selected at random from an 8-hour block of time for\u003cbr/\u003eeach Amazon Web Services Region. For more information, see Backup window\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The daily time range for creating automated backups is managed\u003cbr/\u003eby the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time range each week during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC). For more information, see Amazon RDS Maintenance\u003cbr/\u003eWindow (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe number of CPU cores and the number of threads per core for the DB instance\u003cbr/\u003eclass of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessorFeatures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the processor features of a DB instance class.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eTo specify the number of CPU cores, use the coreCount feature name for the\nName parameter. To specify the number of threads per core, use the threadsPerCore\nfeature name for the Name parameter.\u003c/p\u003e\n\u003cp\u003eYou can set the processor features of the DB instance class for a DB instance\nwhen you call one of the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromS3\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceToPointInTime\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou can view the valid processor values for a particular instance class by\ncalling the DescribeOrderableDBInstanceOptions action and specifying the\ninstance class for the DBInstanceClass parameter.\u003c/p\u003e\n\u003cp\u003eIn addition, you can use the following actions for DB instance class processor\ninformation:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBInstances\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBSnapshots\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeValidDBInstanceModifications\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you call DescribeDBInstances, ProcessorFeature returns non-null values\nonly if the following conditions are met:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eYou are accessing an Oracle DB instance.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eYour Oracle DB instance class supports configuring the number of CPU\ncores and threads per core.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe current number CPU cores and threads is set to a non-default value.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Configuring the Processor of the DB Instance Class\n(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)\nin the Amazon RDS User Guide. || \u003cstrong\u003eprocessorFeatures.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprocessorFeatures.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003epromotionTier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eA value that specifies the order in which an Aurora Replica is promoted to\u003cbr/\u003ethe primary instance after a failure of the existing primary instance. For\u003cbr/\u003emore information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0 - 15 |\n| \u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is publicly accessible.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB instance is publicly accessible, its Domain Name System (DNS)\u003cbr/\u003eendpoint resolves to the private IP address from within the DB instance\u0026rsquo;s\u003cbr/\u003evirtual private cloud (VPC). It resolves to the public IP address from outside\u003cbr/\u003eof the DB instance\u0026rsquo;s VPC. Access to the DB instance is ultimately controlled\u003cbr/\u003eby the security group it uses. That public access is not permitted if the\u003cbr/\u003esecurity group assigned to the DB instance doesn\u0026rsquo;t permit it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB instance isn\u0026rsquo;t publicly accessible, it is an internal DB instance\u003cbr/\u003ewith a DNS name that resolves to a private IP address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default behavior varies depending on whether DBSubnetGroupName\u003cbr/\u003eis specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName isn\u0026rsquo;t specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB instance is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region has an internet gateway attached\u003cbr/\u003e to it, the DB instance is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName is specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB instance is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that has an internet gateway attached\u003cbr/\u003e to it, the DB instance is public. |\n| \u003cstrong\u003ereplicaMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe open mode of the replica database: mounted or read-only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for Oracle DB instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMounted DB replicas are included in Oracle Database Enterprise Edition. The\u003cbr/\u003emain use case for mounted replicas is cross-Region disaster recovery. The\u003cbr/\u003eprimary database doesn\u0026rsquo;t use Active Data Guard to transmit information to\u003cbr/\u003ethe mounted replica. Because it doesn\u0026rsquo;t accept user connections, a mounted\u003cbr/\u003ereplica can\u0026rsquo;t serve a read-only workload.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create a combination of mounted and read-only DB replicas for the\u003cbr/\u003esame primary DB instance. For more information, see Working with Oracle Read\u003cbr/\u003eReplicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RDS Custom, you must specify this parameter and set it to mounted. The\u003cbr/\u003evalue won\u0026rsquo;t be set by default. After replica creation, you can manage the\u003cbr/\u003eopen mode manually. |\n| \u003cstrong\u003esourceDBInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the DB instance that will act as the source for the read\u003cbr/\u003ereplica. Each DB instance can have up to 15 read replicas, with the exception\u003cbr/\u003eof Oracle and SQL Server, which can have up to five.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL,\u003cbr/\u003e or SQL Server DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified if the SourceDBClusterIdentifier parameter is also\u003cbr/\u003e specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the limitations of Oracle read replicas, see Version and licensing\u003cbr/\u003e considerations for RDS for Oracle replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses)\u003cbr/\u003e in the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the limitations of SQL Server read replicas, see Read replica limitations\u003cbr/\u003e with SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations)\u003cbr/\u003e in the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The specified DB instance must have automatic backups enabled, that\u003cbr/\u003e is, its backup retention period must be greater than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the source DB instance is in the same Amazon Web Services Region\u003cbr/\u003e as the read replica, specify a valid DB instance identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the source DB instance is in a different Amazon Web Services Region\u003cbr/\u003e from the read replica, specify a valid DB instance ARN. For more information,\u003cbr/\u003e see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)\u003cbr/\u003e in the Amazon RDS User Guide. This doesn\u0026rsquo;t apply to SQL Server or RDS\u003cbr/\u003e Custom, which don\u0026rsquo;t support cross-Region replicas. |\n| \u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN. |\n| \u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is encrypted. By default,\u003cbr/\u003eit isn\u0026rsquo;t encrypted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RDS Custom instances, either set this parameter to true or leave it unset.\u003cbr/\u003eIf you set this parameter to false, RDS reports an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The encryption for DB instances is managed by the DB cluster. |\n| \u003cstrong\u003estorageThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage throughput value for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only to the gp3 storage type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom or Amazon Aurora. |\n| \u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage type to be associated with the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: gp2 | gp3 | io1 | standard\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify io1 or gp3, you must also include a value for the Iops parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: io1 if the Iops parameter is specified, otherwise gp2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB instance. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etdeCredentialARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN from the key store with which to associate the instance for TDE encryption.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. |\n| \u003cstrong\u003etdeCredentialPassword\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe password for the given ARN from the key store in order to access the\u003cbr/\u003edevice.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. |\n| \u003cstrong\u003etimezone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time zone of the DB instance. The time zone parameter is currently supported\u003cbr/\u003eonly by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). |\n| \u003cstrong\u003euseDefaultProcessorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance class of the DB instance uses\u003cbr/\u003eits default processor features.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon EC2 VPC security groups to associate with this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The associated list of EC2 VPC security groups is managed\u003cbr/\u003eby the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default EC2 VPC security group for the DB subnet group\u0026rsquo;s VPC. |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactivityStreamEngineNativeAuditFieldsIncluded: boolean\nactivityStreamKMSKeyID: string\nactivityStreamKinesisStreamName: string\nactivityStreamMode: string\nactivityStreamPolicyStatus: string\nactivityStreamStatus: string\nassociatedRoles:\n- featureName: string\n roleARN: string\n status: string\nautomaticRestartTime: string\nautomationMode: string\nawsBackupRecoveryPointARN: string\ncertificateDetails: \n cAIdentifier: string\n validTill: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncustomerOwnedIPEnabled: boolean\ndbInstanceAutomatedBackupsReplications:\n- dbInstanceAutomatedBackupsARN: string\ndbInstancePort: integer\ndbInstanceStatus: string\ndbParameterGroups:\n- dbParameterGroupName: string\n parameterApplyStatus: string\ndbSubnetGroup: \n dbSubnetGroupARN: string\n dbSubnetGroupDescription: string\n dbSubnetGroupName: string\n subnetGroupStatus: string\n subnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n arn: string\n subnetStatus: string\n supportedNetworkTypes:\n - string\n vpcID: string\ndbSystemID: string\ndbiResourceID: string\ndomainMemberships:\n- domain: string\n fQDN: string\n iamRoleName: string\n status: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: \n address: string\n hostedZoneID: string\n port: integer\nenhancedMonitoringResourceARN: string\niamDatabaseAuthenticationEnabled: boolean\ninstanceCreateTime: string\nlatestRestorableTime: string\nlistenerEndpoint: \n address: string\n hostedZoneID: string\n port: integer\nmasterUserSecret: \n kmsKeyID: string\n secretARN: string\n secretStatus: string\noptionGroupMemberships:\n- optionGroupName: string\n status: string\npendingModifiedValues: \n allocatedStorage: integer\n automationMode: string\n backupRetentionPeriod: integer\n caCertificateIdentifier: string\n dbInstanceClass: string\n dbInstanceIdentifier: string\n dbSubnetGroupName: string\n engineVersion: string\n iamDatabaseAuthenticationEnabled: boolean\n iops: integer\n licenseModel: string\n masterUserPassword: string\n multiAZ: boolean\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\n port: integer\n processorFeatures:\n - name: string\n value: string\n resumeFullAutomationModeTime: string\n storageThroughput: integer\n storageType: string\nreadReplicaDBClusterIdentifiers:\n- string\nreadReplicaDBInstanceIdentifiers:\n- string\nreadReplicaSourceDBClusterIdentifier: string\nreadReplicaSourceDBInstanceIdentifier: string\nresumeFullAutomationModeTime: string\nsecondaryAvailabilityZone: string\nstatusInfos:\n- message: string\n normal: boolean\n status: string\n statusType: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamEngineNativeAuditFieldsIncluded\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether engine-native audit fields are included in the database\u003cbr/\u003eactivity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier used for encrypting messages in\u003cbr/\u003ethe database activity stream. The Amazon Web Services KMS key identifier\u003cbr/\u003eis the key ARN, key ID, alias ARN, or alias name for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKinesisStreamName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon Kinesis data stream used for the database activity\u003cbr/\u003estream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of the database activity stream. Database events such as a change\u003cbr/\u003eor access generate an activity stream event. RDS for Oracle always handles\u003cbr/\u003ethese events asynchronously.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamPolicyStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the policy state of the activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the database activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Identity and Access Management (IAM) roles associated\u003cbr/\u003ewith the DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Amazon Web Services Identity and Access Management (IAM) role\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is associated with a DB instance.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticRestartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when a stopped DB instance is restarted automatically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomationMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe automation mode of the RDS Custom DB instance: full or all paused. If\u003cbr/\u003efull, the DB instance automates monitoring and instance recovery. If all\u003cbr/\u003epaused, the instance pauses automation for the duration set by \u0026ndash;resume-full-automation-mode-minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eawsBackupRecoveryPointARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the recovery point in Amazon Web Services\u003cbr/\u003eBackup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the DB instance\u0026rsquo;s server certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.cAIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.validTill\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a customer-owned IP address (CoIP) is enabled for an RDS\u003cbr/\u003eon Outposts DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA CoIP provides local or external connectivity to resources in your Outpost\u003cbr/\u003esubnets through your on-premises network. For some use cases, a CoIP can\u003cbr/\u003eprovide lower latency for connections to the DB instance from outside of\u003cbr/\u003eits virtual private cloud (VPC) on your local network.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Working with Amazon RDS on\u003cbr/\u003eAmazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)\u003cbr/\u003ein the Amazon Web Services Outposts User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceAutomatedBackupsReplications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of replicated automated backups associated with the DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceAutomatedBackupsReplications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAutomated backups of a DB instance replicated to another Amazon Web Services\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eRegion. They consist of system backups, transaction logs, and database instance\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eproperties.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstancePort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the port that the DB instance listens on. If the DB instance is\u003cbr/\u003epart of a DB cluster, this can be a different port than the DB cluster port.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this database.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about DB instance statuses, see Viewing DB instance status\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of DB parameter groups applied to this DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstanceReadReplica\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDeleteDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRebootDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot || \u003cstrong\u003edbParameterGroups.[].dbParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbParameterGroups.[].parameterApplyStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group associated with the DB instance,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group. |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for the DescribeDBSubnetGroups\noperation. || \u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains Availability Zone information.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis data type is used as an element in the OrderableDBInstanceOption data\u003cbr/\u003etype. |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data type that represents an Outpost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Amazon RDS on Amazon Web\u003cbr/\u003eServices Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetOutpost.arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.supportedNetworkTypes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.supportedNetworkTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edbSubnetGroup.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Oracle system ID (Oracle SID) for a container database (CDB). The Oracle\u003cbr/\u003eSID is also the name of the CDB. This setting is valid for RDS Custom only. |\n| \u003cstrong\u003edbiResourceID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the DB instance.\u003cbr/\u003eThis identifier is found in Amazon Web Services CloudTrail log entries whenever\u003cbr/\u003ethe Amazon Web Services KMS key for the DB instance is accessed. |\n| \u003cstrong\u003edomainMemberships\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Active Directory Domain membership records associated with the DB instance. |\n| \u003cstrong\u003edomainMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Active Directory Domain membership record associated with the DB instance\nor cluster. || \u003cstrong\u003edomainMemberships.[].domain\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].fQDN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].iamRoleName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this DB instance is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLog types vary by DB engine. For information about the log types for each\u003cbr/\u003eDB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the connection endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe endpoint might not be shown for instances whose status is creating. |\n| \u003cstrong\u003eendpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eendpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eendpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eenhancedMonitoringResourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that\u003cbr/\u003ereceives the Enhanced Monitoring metrics data for the DB instance. |\n| \u003cstrong\u003eiamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTrue if mapping of Amazon Web Services Identity and Access Management (IAM)\u003cbr/\u003eaccounts to database accounts is enabled, and otherwise false.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM database authentication can be enabled for the following database engines\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For MySQL 5.6, minor version 5.6.34 or higher\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For MySQL 5.7, minor version 5.7.16 or higher\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora 5.6 or higher. To enable IAM database authentication for Aurora,\u003cbr/\u003e see DBCluster Type. |\n| \u003cstrong\u003einstanceCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the date and time the DB instance was created. |\n| \u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore. |\n| \u003cstrong\u003elistenerEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the listener connection endpoint for SQL Server Always On. |\n| \u003cstrong\u003elistenerEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elistenerEndpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elistenerEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the secret managed by RDS in Amazon Web Services Secrets Manager\u003cbr/\u003efor the master user password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003emasterUserSecret.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret.secretARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret.secretStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eoptionGroupMemberships\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of option group memberships for this DB instance. |\n| \u003cstrong\u003eoptionGroupMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides information on the option groups the DB instance is a member of. || \u003cstrong\u003eoptionGroupMemberships.[].optionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eoptionGroupMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA value that specifies that changes to the DB instance are pending. This\u003cbr/\u003eelement is only included when changes are pending. Specific changes are identified\u003cbr/\u003eby subelements. |\n| \u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.automationMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.caCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.iamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.licenseModel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.multiAZ\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. In other words,\u003cbr/\u003ethese log types are in the process of being activated or deactivated. |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ependingModifiedValues.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the processor features of a DB instance class.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eTo specify the number of CPU cores, use the coreCount feature name for the\nName parameter. To specify the number of threads per core, use the threadsPerCore\nfeature name for the Name parameter.\u003c/p\u003e\n\u003cp\u003eYou can set the processor features of the DB instance class for a DB instance\nwhen you call one of the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromS3\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceToPointInTime\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou can view the valid processor values for a particular instance class by\ncalling the DescribeOrderableDBInstanceOptions action and specifying the\ninstance class for the DBInstanceClass parameter.\u003c/p\u003e\n\u003cp\u003eIn addition, you can use the following actions for DB instance class processor\ninformation:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBInstances\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBSnapshots\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeValidDBInstanceModifications\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you call DescribeDBInstances, ProcessorFeature returns non-null values\nonly if the following conditions are met:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eYou are accessing an Oracle DB instance.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eYour Oracle DB instance class supports configuring the number of CPU\ncores and threads per core.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe current number CPU cores and threads is set to a non-default value.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Configuring the Processor of the DB Instance Class\n(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)\nin the Amazon RDS User Guide. || \u003cstrong\u003ependingModifiedValues.processorFeatures.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.resumeFullAutomationModeTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.storageThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.storageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereadReplicaDBClusterIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of Aurora DB clusters to which the RDS DB\u003cbr/\u003einstance is replicated as a read replica. For example, when you create an\u003cbr/\u003eAurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB\u003cbr/\u003ecluster for the Aurora read replica is shown. This output doesn\u0026rsquo;t contain\u003cbr/\u003einformation about cross-Region Aurora read replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCurrently, each RDS DB instance can have only one Aurora read replica. |\n| \u003cstrong\u003ereadReplicaDBClusterIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ereadReplicaDBInstanceIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the read replicas associated with this\u003cbr/\u003eDB instance. |\n| \u003cstrong\u003ereadReplicaDBInstanceIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ereadReplicaSourceDBClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source DB cluster if this DB instance is a\u003cbr/\u003eread replica. |\n| \u003cstrong\u003ereadReplicaSourceDBInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source DB instance if this DB instance is\u003cbr/\u003ea read replica. |\n| \u003cstrong\u003eresumeFullAutomationModeTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe number of minutes to pause the automation. When the time period ends,\u003cbr/\u003eRDS Custom resumes full automation. The minimum value is 60 (default). The\u003cbr/\u003emaximum value is 1,440. |\n| \u003cstrong\u003esecondaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf present, specifies the name of the secondary Availability Zone for a DB\u003cbr/\u003einstance with multi-AZ support. |\n| \u003cstrong\u003estatusInfos\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe status of a read replica. If the instance isn\u0026rsquo;t a read replica, this\u003cbr/\u003eis blank. |\n| \u003cstrong\u003estatusInfos.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides a list of status information for a DB instance. || \u003cstrong\u003estatusInfos.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].normal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].statusType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security group elements that the DB instance belongs\u003cbr/\u003eto. |\n| \u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for queries on VPC security\ngroup membership. || \u003cstrong\u003evpcSecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:80,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbparametergroup/",title:"DBParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBParameterGroup"\u003erds-controller/apis/v1alpha1#DBParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB parameter group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBParameterGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterOverrides: {}\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB parameter group family name. A DB parameter group can be associated\u003cbr/\u003ewith one and only one DB parameter group family, and can be applied only\u003cbr/\u003eto a DB instance running a database engine and engine version compatible\u003cbr/\u003ewith that DB parameter group family.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available parameter group families for a DB engine, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine \u003cengine\u003e\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to list all of the available parameter group families for the\u003cbr/\u003eMySQL DB engine, use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe output contains duplicates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the valid DB engine values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mariadb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-se\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ex\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-web\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 255 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is stored as a lowercase string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameterOverrideStatuses:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Parameter values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameterOverrideStatuses.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:81,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbproxy/",title:"DBProxy",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBProxy"\u003erds-controller/apis/v1alpha1#DBProxy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBProxy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBProxyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbproxies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbproxy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe data structure representing a proxy managed by the RDS Proxy.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBProxies action.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauth:\n- authScheme: string\n clientPasswordAuthType: string\n description: string\n iamAuth: string\n secretARN: string\n userName: string\ndebugLogging: boolean\nengineFamily: string\nidleClientTimeout: integer\nname: string\nrequireTLS: boolean\nroleARN: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSubnetIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe authorization mechanism that the proxy uses.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the details of authentication used by a proxy to log in as a specific\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edatabase user.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].clientPasswordAuthType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].iamAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].secretARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].userName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugLogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhether the proxy includes detailed information about SQL statements in its\u003cbr/\u003elogs. This information helps you to debug issues involving SQL behavior or\u003cbr/\u003ethe performance and scalability of the proxy connections. The debug information\u003cbr/\u003eincludes the text of SQL statements that you submit through the proxy. Thus,\u003cbr/\u003eonly enable this setting when needed for debugging, and only when you have\u003cbr/\u003esecurity measures in place to safeguard any sensitive information that appears\u003cbr/\u003ein the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineFamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe kinds of databases that the proxy can connect to. This value determines\u003cbr/\u003ewhich database network protocol the proxy recognizes when it interprets network\u003cbr/\u003etraffic to and from the database. For Aurora MySQL, RDS for MariaDB, and\u003cbr/\u003eRDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for\u003cbr/\u003ePostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server,\u003cbr/\u003especify SQLSERVER.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidleClientTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of seconds that a connection to the proxy can be inactive before\u003cbr/\u003ethe proxy disconnects it. You can set this value higher or lower than the\u003cbr/\u003econnection timeout limit for the associated database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the proxy. This name must be unique for all proxies owned\u003cbr/\u003eby your Amazon Web Services account in the specified Amazon Web Services\u003cbr/\u003eRegion. An identifier must begin with a letter and must contain only ASCII\u003cbr/\u003eletters, digits, and hyphens; it can\u0026rsquo;t end with a hyphen or contain two consecutive\u003cbr/\u003ehyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequireTLS\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA Boolean parameter that specifies whether Transport Layer Security (TLS)\u003cbr/\u003eencryption is required for connections to the proxy. By enabling this setting,\u003cbr/\u003eyou can enforce encrypted TLS connections to the proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access\u003cbr/\u003esecrets in Amazon Web Services Secrets Manager.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn optional set of key-value pairs to associate arbitrary data of your choosing\u003cbr/\u003ewith the proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more VPC security group IDs to associate with the new proxy. |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSubnetIDs\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more VPC subnet IDs to associate with the new proxy. |\n| \u003cstrong\u003evpcSubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nendpoint: string\nstatus: string\nupdatedDate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the proxy was first created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint that you can use to connect to the DB proxy. You include the\u003cbr/\u003eendpoint value in the connection string for a database client application.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of this proxy. A status of available means the proxy is\u003cbr/\u003eready to handle requests. Other values indicate that you must wait for the\u003cbr/\u003eproxy to be ready, or take some action to resolve an issue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the proxy was last updated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the VPC ID of the DB proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:82,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbsubnetgroup/",title:"DBSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBSubnetGroup"\u003edocumentdb-controller/apis/v1alpha1#DBSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about a subnet group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the subnet group. This value is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain no more than 255 letters, numbers, periods, underscores,\u003cbr/\u003espaces, or hyphens. Must not be default.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mySubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon EC2 subnet IDs for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the subnet group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\npair. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnetGroupStatus: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetStatus: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eDetailed information about one or more subnets within a subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the virtual private cloud (VPC) ID of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:83,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbsubnetgroup/",title:"DBSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBSubnetGroup"\u003erds-controller/apis/v1alpha1#DBSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB subnet group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBSubnetGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the DB subnet group. This value is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain no more than 255 letters, numbers, periods, underscores,\u003cbr/\u003e spaces, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not be default.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe EC2 Subnet IDs for the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB subnet group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnetGroupStatus: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n arn: string\n subnetStatus: string\nsupportedNetworkTypes:\n- string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of Subnet elements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for the DescribeDBSubnetGroups\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eoperation.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data type that represents an Outpost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Amazon RDS on Amazon Web\u003cbr/\u003eServices Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedNetworkTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB subnet group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6\u003cbr/\u003eprotocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedNetworkTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:84,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/deployment/",title:"Deployment",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Deployment"\u003eapigatewayv2-controller/apis/v1alpha1#Deployment\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDeployment\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDeploymentList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edeployments\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edeployment\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn immutable representation of an API that can be called by users. A Deployment\nmust be associated with a Stage for it to be callable over the internet.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\ndescription: string\nstageName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nautoDeployed: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\ndeploymentID: string\ndeploymentStatus: string\ndeploymentStatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoDeployed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:85,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/dhcpoptions/",title:"DHCPOptions",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#DHCPOptions"\u003eec2-controller/apis/v1alpha1#DHCPOptions\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDHCPOptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDHCPOptionsList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edhcpoptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edhcpoptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a set of DHCP options.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edhcpConfigurations:\n- key: string\n values:\n - string\ntags:\n- key: string\n value: string\nvpc:\n- string\nvpcRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA DHCP configuration option.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[].values\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndhcpOptionsID: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpOptionsID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the set of DHCP options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the DHCP options set.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:86,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/distribution/",title:"Distribution",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#Distribution"\u003ecloudfront-controller/apis/v1alpha1#Distribution\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDistribution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDistributionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edistributions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edistribution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA distribution tells CloudFront where you want content to be delivered from,\nand the details about how to track and manage content delivery.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edistributionConfig: \n aliases: \n items:\n - string\n cacheBehaviors: \n items:\n allowedMethods: \n cachedMethods: \n items:\n - string\n items:\n - string\n cachePolicyID: string\n compress: boolean\n defaultTTL: integer\n fieldLevelEncryptionID: string\n forwardedValues: \n cookies: \n forward: string\n whitelistedNames: \n items:\n - string\n headers: \n items:\n - string\n queryString: boolean\n queryStringCacheKeys: \n items:\n - string\n functionAssociations: \n items:\n - eventType: string\n functionARN: string\n lambdaFunctionAssociations: \n items:\n - eventType: string\n includeBody: boolean\n lambdaFunctionARN: string\n maxTTL: integer\n minTTL: integer\n originRequestPolicyID: string\n pathPattern: string\n realtimeLogConfigARN: string\n responseHeadersPolicyID: string\n smoothStreaming: boolean\n targetOriginID: string\n trustedKeyGroups: \n enabled: boolean\n items:\n - string\n trustedSigners: \n enabled: boolean\n items:\n - string\n viewerProtocolPolicy: string\n comment: string\n continuousDeploymentPolicyID: string\n customErrorResponses: \n items:\n - errorCachingMinTTL: integer\n errorCode: integer\n responseCode: string\n responsePagePath: string\n defaultCacheBehavior: \n allowedMethods: \n cachedMethods: \n items:\n - string\n items:\n - string\n cachePolicyID: string\n compress: boolean\n defaultTTL: integer\n fieldLevelEncryptionID: string\n forwardedValues: \n cookies: \n forward: string\n whitelistedNames: \n items:\n - string\n headers: \n items:\n - string\n queryString: boolean\n queryStringCacheKeys: \n items:\n - string\n functionAssociations: \n items:\n - eventType: string\n functionARN: string\n lambdaFunctionAssociations: \n items:\n - eventType: string\n includeBody: boolean\n lambdaFunctionARN: string\n maxTTL: integer\n minTTL: integer\n originRequestPolicyID: string\n realtimeLogConfigARN: string\n responseHeadersPolicyID: string\n smoothStreaming: boolean\n targetOriginID: string\n trustedKeyGroups: \n enabled: boolean\n items:\n - string\n trustedSigners: \n enabled: boolean\n items:\n - string\n viewerProtocolPolicy: string\n defaultRootObject: string\n enabled: boolean\n httpVersion: string\n isIPV6Enabled: boolean\n logging: \n bucket: string\n enabled: boolean\n includeCookies: boolean\n prefix: string\n originGroups: \n items:\n failoverCriteria: \n statusCodes: \n items:\n - integer\n id: string\n members: \n items:\n - originID: string\n origins: \n items:\n - connectionAttempts: integer\n connectionTimeout: integer\n customHeaders: \n items:\n - headerName: string\n headerValue: string\n customOriginConfig: \n httpPort: integer\n httpSPort: integer\n originKeepaliveTimeout: integer\n originProtocolPolicy: string\n originReadTimeout: integer\n originSSLProtocols: \n items:\n - string\n domainName: string\n id: string\n originAccessControlID: string\n originPath: string\n originShield: \n enabled: boolean\n originShieldRegion: string\n s3OriginConfig: \n originAccessIdentity: string\n priceClass: string\n restrictions: \n geoRestriction: \n items:\n - string\n restrictionType: string\n staging: boolean\n viewerCertificate: \n acmCertificateARN: string\n acmCertificateRef: \n from: \n name: string\n certificate: string\n certificateSource: string\n cloudFrontDefaultCertificate: boolean\n iamCertificateID: string\n minimumProtocolVersion: string\n sslSupportMethod: string\n webACLID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s configuration information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about CNAMEs (alternate domain names),\u003cbr/\u003eif any, for this distribution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.cacheBehaviors.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.cacheBehaviors.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that describes how CloudFront processes requests.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou must create at least as many cache behaviors (including the default cache\nbehavior) as you have origins if you want CloudFront to serve objects from\nall of the origins. Each cache behavior specifies the one origin from which\nyou want CloudFront to get objects. If you have two origins and only the\ndefault cache behavior, the default cache behavior will cause CloudFront\nto get objects from one of the origins, but the other origin is never used.\u003c/p\u003e\n\u003cp\u003eFor the current quota (formerly known as limit) on the number of cache behaviors\nthat you can add to a distribution, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html)\nin the Amazon CloudFront Developer Guide.\u003c/p\u003e\n\u003cp\u003eIf you don\u0026rsquo;t want to specify any cache behaviors, include only an empty CacheBehaviors\nelement. Don\u0026rsquo;t include an empty CacheBehavior element because this is invalid.\u003c/p\u003e\n\u003cp\u003eTo delete all cache behaviors in an existing distribution, update the distribution\nconfiguration and include only an empty CacheBehaviors element.\u003c/p\u003e\n\u003cp\u003eTo add, change, or remove one or more cache behaviors, update the distribution\nconfiguration and specify all of the cache behaviors that you want to include\nin the updated distribution.\u003c/p\u003e\n\u003cp\u003eFor more information about cache behaviors, see Cache Behavior Settings (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior)\nin the Amazon CloudFront Developer Guide. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls which HTTP methods CloudFront processes and\u003cbr/\u003eforwards to your Amazon S3 bucket or your custom origin. There are three\u003cbr/\u003echoices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE\u003cbr/\u003e requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the third choice, you may need to restrict access to your Amazon\u003cbr/\u003eS3 bucket or to your custom origin so users can\u0026rsquo;t perform operations that\u003cbr/\u003eyou don\u0026rsquo;t want them to. For example, you might not want users to have permissions\u003cbr/\u003eto delete objects from your origin. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether CloudFront caches the response to requests\u003cbr/\u003eusing the specified HTTP methods. There are two choices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the second choice for your Amazon S3 Origin, you may need to\u003cbr/\u003eforward Access-Control-Request-Method, Access-Control-Request-Headers, and\u003cbr/\u003eOrigin headers for the responses to be cached correctly. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].cachePolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].compress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].fieldLevelEncryptionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include values in the cache key, use a cache policy. For more\u003cbr/\u003einformation, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send values to the origin but not include them in the cache\u003cbr/\u003ekey, use an origin request policy. For more information, see Creating origin\u003cbr/\u003erequest policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies how CloudFront handles query strings, cookies,\u003cbr/\u003eand HTTP headers. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include cookies in the cache key, use CookiesConfig in a cache\u003cbr/\u003epolicy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send cookies to the origin but not include them in the cache\u003cbr/\u003ekey, use CookiesConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies whether you want CloudFront to forward cookies\u003cbr/\u003eto the origin and, if so, which ones. For more information about forwarding\u003cbr/\u003ecookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.forward\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryString\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include query strings in the cache key, use QueryStringsConfig\u003cbr/\u003ein a cache policy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send query strings to the origin but not include them in the\u003cbr/\u003ecache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that contains information about the query string parameters\u003cbr/\u003ethat you want CloudFront to use for caching for a cache behavior. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront functions that are associated with a cache behavior\u003cbr/\u003ein a CloudFront distribution. CloudFront functions must be published to the\u003cbr/\u003eLIVE stage to associate them with a cache behavior. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA CloudFront function that is associated with a cache behavior in a CloudFront\ndistribution. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[].functionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that specifies a list of Lambda@Edge functions associations\u003cbr/\u003efor a cache behavior.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to invoke one or more Lambda@Edge functions triggered by requests\u003cbr/\u003ethat match the PathPattern of the cache behavior, specify the applicable\u003cbr/\u003evalues for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation\u003cbr/\u003eitems in this list (one for each possible value of EventType) and each EventType\u003cbr/\u003ecan be associated with only one function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t want to invoke any Lambda@Edge functions for the requests that\u003cbr/\u003ematch PathPattern, specify 0 for Quantity and omit Items. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a Lambda@Edge function association. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].includeBody\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].lambdaFunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].minTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].originRequestPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].pathPattern\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].realtimeLogConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].responseHeadersPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].smoothStreaming\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].targetOriginID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of key groups whose public keys CloudFront can use to verify the signatures\u003cbr/\u003eof signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts whose public keys CloudFront can use\u003cbr/\u003eto verify the signatures of signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].viewerProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.continuousDeploymentPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range\u003cbr/\u003e with custom error messages before returning the response to the viewer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about custom error pages, see Customizing Error Responses\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range\nwith custom error messages before returning the response to the viewer.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information about custom error pages, see Customizing Error Responses\n(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)\nin the Amazon CloudFront Developer Guide. || \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].errorCachingMinTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].errorCode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].responseCode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].responsePagePath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that describes the default cache behavior if you don\u0026rsquo;t specify\u003cbr/\u003ea CacheBehavior element or if request URLs don\u0026rsquo;t match any of the values\u003cbr/\u003eof PathPattern in CacheBehavior elements. You must create exactly one default\u003cbr/\u003ecache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls which HTTP methods CloudFront processes and\u003cbr/\u003eforwards to your Amazon S3 bucket or your custom origin. There are three\u003cbr/\u003echoices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE\u003cbr/\u003e requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the third choice, you may need to restrict access to your Amazon\u003cbr/\u003eS3 bucket or to your custom origin so users can\u0026rsquo;t perform operations that\u003cbr/\u003eyou don\u0026rsquo;t want them to. For example, you might not want users to have permissions\u003cbr/\u003eto delete objects from your origin. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether CloudFront caches the response to requests\u003cbr/\u003eusing the specified HTTP methods. There are two choices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the second choice for your Amazon S3 Origin, you may need to\u003cbr/\u003eforward Access-Control-Request-Method, Access-Control-Request-Headers, and\u003cbr/\u003eOrigin headers for the responses to be cached correctly. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.cachePolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.compress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.fieldLevelEncryptionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include values in the cache key, use a cache policy. For more\u003cbr/\u003einformation, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send values to the origin but not include them in the cache\u003cbr/\u003ekey, use an origin request policy. For more information, see Creating origin\u003cbr/\u003erequest policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies how CloudFront handles query strings, cookies,\u003cbr/\u003eand HTTP headers. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include cookies in the cache key, use CookiesConfig in a cache\u003cbr/\u003epolicy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send cookies to the origin but not include them in the cache\u003cbr/\u003ekey, use CookiesConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies whether you want CloudFront to forward cookies\u003cbr/\u003eto the origin and, if so, which ones. For more information about forwarding\u003cbr/\u003ecookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.forward\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryString\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include query strings in the cache key, use QueryStringsConfig\u003cbr/\u003ein a cache policy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send query strings to the origin but not include them in the\u003cbr/\u003ecache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that contains information about the query string parameters\u003cbr/\u003ethat you want CloudFront to use for caching for a cache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront functions that are associated with a cache behavior\u003cbr/\u003ein a CloudFront distribution. CloudFront functions must be published to the\u003cbr/\u003eLIVE stage to associate them with a cache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA CloudFront function that is associated with a cache behavior in a CloudFront\ndistribution. || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[].functionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that specifies a list of Lambda@Edge functions associations\u003cbr/\u003efor a cache behavior.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to invoke one or more Lambda@Edge functions triggered by requests\u003cbr/\u003ethat match the PathPattern of the cache behavior, specify the applicable\u003cbr/\u003evalues for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation\u003cbr/\u003eitems in this list (one for each possible value of EventType) and each EventType\u003cbr/\u003ecan be associated with only one function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t want to invoke any Lambda@Edge functions for the requests that\u003cbr/\u003ematch PathPattern, specify 0 for Quantity and omit Items. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a Lambda@Edge function association. || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].includeBody\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].lambdaFunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.minTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.originRequestPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.realtimeLogConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.responseHeadersPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.smoothStreaming\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.targetOriginID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of key groups whose public keys CloudFront can use to verify the signatures\u003cbr/\u003eof signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts whose public keys CloudFront can use\u003cbr/\u003eto verify the signatures of signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.viewerProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultRootObject\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.httpVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.isIPV6Enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether access logs are written for the distribution. |\n| \u003cstrong\u003edistributionConfig.logging.bucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.includeCookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.originGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the origin groups specified for a distribution. |\n| \u003cstrong\u003edistributionConfig.originGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of origin groups for a distribution. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin group includes two origins (a primary origin and a second origin\nto failover to) and a failover criteria that you specify. You create an origin\ngroup to support origin failover in CloudFront. When you create or update\na distribution, you can specifiy the origin group instead of a single origin,\nand CloudFront will failover from the primary origin to the second origin\nunder the failover conditions that you\u0026rsquo;ve chosen. || \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type that includes information about the failover criteria\u003cbr/\u003efor an origin group, including the status codes for which CloudFront will\u003cbr/\u003efailover from the primary origin to the second origin. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the status codes that you specify that, when returned\u003cbr/\u003eby a primary origin, trigger CloudFront to failover to a second origin. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of status codes for origin failover. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.originGroups.items.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the origins included in an origin group. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of origins in an origin group. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin in an origin group. || \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items.[].originID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the origins for this distribution. |\n| \u003cstrong\u003edistributionConfig.origins.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin.\u003c/p\u003e\n\u003cp\u003eAn origin is the location where content is stored, and from which CloudFront\ngets content to serve to viewers. To specify an origin:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eUse S3OriginConfig to specify an Amazon S3 bucket that is not configured\nwith static website hosting.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eUse CustomOriginConfig to specify all other kinds of origins, including:\nAn Amazon S3 bucket that is configured with static website hosting An\nElastic Load Balancing load balancer An AWS Elemental MediaPackage endpoint\nAn AWS Elemental MediaStore container Any other HTTP server, running on\nan Amazon EC2 instance or any other kind of host\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor the current maximum number of origins that you can specify per distribution,\nsee General Quotas on Web Distributions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions)\nin the Amazon CloudFront Developer Guide (quotas were formerly referred to\nas limits). || \u003cstrong\u003edistributionConfig.origins.items.[].connectionAttempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].connectionTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains the list of Custom Headers for each origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains HeaderName and HeaderValue elements, if any,\nfor this distribution. || \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[].headerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[].headerValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom origin. A custom origin is any origin that is not an Amazon S3 bucket,\u003cbr/\u003ewith one exception. An Amazon S3 bucket that is configured with static website\u003cbr/\u003ehosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)\u003cbr/\u003eis a custom origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.httpPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.httpSPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originKeepaliveTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originReadTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about the SSL/TLS protocols that\u003cbr/\u003eCloudFront can use when establishing an HTTPS connection with your origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.origins.items.[].domainName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originAccessControlID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCloudFront Origin Shield.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUsing Origin Shield can help reduce the load on your origin. For more information,\u003cbr/\u003esee Using Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield.originShieldRegion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].s3OriginConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about the Amazon S3 origin. If the\u003cbr/\u003eorigin is a custom origin or an S3 bucket that is configured as a website\u003cbr/\u003eendpoint, use the CustomOriginConfig element instead. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].s3OriginConfig.originAccessIdentity\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.priceClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.restrictions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that identifies ways in which you want to restrict distribution\u003cbr/\u003eof your content. |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls the countries in which your content is distributed.\u003cbr/\u003eCloudFront determines the location of your users using MaxMind GeoIP databases. |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.restrictionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.staging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that determines the distribution\u0026rsquo;s SSL/TLS configuration for\u003cbr/\u003ecommunicating with viewers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the distribution doesn\u0026rsquo;t use Aliases (also known as alternate domain names\u003cbr/\u003eor CNAMEs)—that is, if the distribution uses the CloudFront domain name\u003cbr/\u003esuch as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate\u003cbr/\u003eto true and leave all other fields empty.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the distribution uses Aliases (alternate domain names or CNAMEs), use\u003cbr/\u003ethe fields in this type to specify the following settings:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Which viewers the distribution accepts HTTPS connections from: only\u003cbr/\u003e viewers that support server name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication)\u003cbr/\u003e (recommended), or all viewers including those that don\u0026rsquo;t support SNI.\u003cbr/\u003e To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod\u003cbr/\u003e to sni-only. This is recommended. Most browsers and clients support SNI.\u003cbr/\u003e To accept HTTPS connections from all viewers, including those that don\u0026rsquo;t\u003cbr/\u003e support SNI, set SSLSupportMethod to vip. This is not recommended, and\u003cbr/\u003e results in additional monthly charges from CloudFront.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The minimum SSL/TLS protocol version that the distribution can use to\u003cbr/\u003e communicate with viewers. To specify a minimum version, choose a value\u003cbr/\u003e for MinimumProtocolVersion. For more information, see Security Policy\u003cbr/\u003e (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy)\u003cbr/\u003e in the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The location of the SSL/TLS certificate, Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html)\u003cbr/\u003e (recommended) or Identity and Access Management (IAM) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html).\u003cbr/\u003e You specify the location by setting a value in one of the following fields\u003cbr/\u003e (not both): ACMCertificateArn IAMCertificateId\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll distributions support HTTPS connections from viewers. To require viewers\u003cbr/\u003eto use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy\u003cbr/\u003ein the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should\u003cbr/\u003euse SSL/TLS to communicate with your custom origin, use CustomOriginConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using HTTPS with CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html)\u003cbr/\u003eand Using Alternate Domain Names and HTTPS (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for ACMCertificateARN |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.certificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.certificateSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.cloudFrontDefaultCertificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.iamCertificateID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.minimumProtocolVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.sslSupportMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.webACLID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactiveTrustedKeyGroups: \n enabled: boolean\n items:\n - keyGroupID: string\n keyPairIDs: \n items:\n - string\n quantity: integer\nactiveTrustedSigners: \n enabled: boolean\n items:\n - awsAccountNumber: string\n keyPairIDs: \n items:\n - string\n quantity: integer\naliasICPRecordals:\n- cname: string\n iCPRecordalStatus: string\ncallerReference: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndomainName: string\neTag: string\nid: string\ninProgressInvalidationBatches: integer\nlastModifiedTime: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field contains a list of key groups and the public keys in each key\u003cbr/\u003egroup that CloudFront can use to verify the signatures of signed URLs or\u003cbr/\u003esigned cookies.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of identifiers for the public keys that CloudFront can use to verify\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe signatures of signed URLs and signed cookies.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront key pair identifiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe recommend using TrustedKeyGroups instead of TrustedSigners.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis field contains a list of Amazon Web Services account IDs and the active\u003cbr/\u003eCloudFront key pairs in each account that CloudFront can use to verify the\u003cbr/\u003esignatures of signed URLs or signed cookies.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts and the active CloudFront key pairs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein each account that CloudFront can use to verify the signatures of signed\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eURLs and signed cookies.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront key pair identifiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasICPRecordals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services services in China customers must file for an Internet\u003cbr/\u003eContent Provider (ICP) recordal if they want to serve content publicly on\u003cbr/\u003ean alternate domain name, also known as a CNAME, that they\u0026rsquo;ve added to CloudFront.\u003cbr/\u003eAliasICPRecordal provides the ICP recordal status for CNAMEs associated with\u003cbr/\u003edistributions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about ICP recordals, see Signup, Accounts, and Credentials\u003cbr/\u003e(https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html)\u003cbr/\u003ein Getting Started with Amazon Web Services services in China.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasICPRecordals.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services services in China customers must file for an Internet\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eContent Provider (ICP) recordal if they want to serve content publicly on\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ean alternate domain name, also known as a CNAME, that they\u0026rsquo;ve added to CloudFront.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAliasICPRecordal provides the ICP recordal status for CNAMEs associated with\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edistributions. The status is returned in the CloudFront response; you can\u0026rsquo;t\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econfigure it yourself.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information about ICP recordals, see Signup, Accounts, and Credentials\n(https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html)\nin Getting Started with Amazon Web Services services in China. || \u003cstrong\u003ealiasICPRecordals.[].cname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ealiasICPRecordals.[].iCPRecordalStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecallerReference\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource |\n| \u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\ncontrollers to indicate terminal states of the CR and its backend AWS\nservice API resource || \u003cstrong\u003econditions.[].lastTransitionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLast time the condition transitioned from one status to another. |\n| \u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition. |\n| \u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition. |\n| \u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown. |\n| \u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition |\n| \u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s CloudFront domain name. For example: d111111abcdef8.cloudfront.net. |\n| \u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current version of the distribution created. |\n| \u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s identifier. For example: E1U5RQF7T870K0. |\n| \u003cstrong\u003einProgressInvalidationBatches\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of invalidation batches currently in progress. |\n| \u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the distribution was last modified. |\n| \u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s status. When the status is Deployed, the distribution\u0026rsquo;s\u003cbr/\u003einformation is fully propagated to all CloudFront edge locations. |\u003c/p\u003e\n'}).add({id:87,href:"https://aws-controllers-k8s.github.io/community/docs/",title:"Docs",description:null,content:""}).add({id:88,href:"https://aws-controllers-k8s.github.io/community/reference/opensearchservice/v1alpha1/domain/",title:"Domain",description:null,content:'\u003cp\u003e\u003ccode\u003eopensearchservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/opensearchservice-controller/apis/v1alpha1#Domain"\u003eopensearchservice-controller/apis/v1alpha1#Domain\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomainList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomains\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPolicies: string\nadvancedOptions: {}\nadvancedSecurityOptions: \n anonymousAuthEnabled: boolean\n enabled: boolean\n internalUserDatabaseEnabled: boolean\n masterUserOptions: \n masterUserARN: string\n masterUserName: string\n masterUserPassword: \n key: string\n name: string\n namespace: string\n sAMLOptions: \n enabled: boolean\n idp: \n entityID: string\n metadataContent: string\n masterBackendRole: string\n masterUserName: string\n rolesKey: string\n sessionTimeoutMinutes: integer\n subjectKey: string\nautoTuneOptions: \n desiredState: string\n maintenanceSchedules:\n - cronExpressionForRecurrence: string\n duration: \n unit: string\n value: integer\n startAt: string\nclusterConfig: \n coldStorageOptions: \n enabled: boolean\n dedicatedMasterCount: integer\n dedicatedMasterEnabled: boolean\n dedicatedMasterType: string\n instanceCount: integer\n instanceType: string\n warmCount: integer\n warmEnabled: boolean\n warmType: string\n zoneAwarenessConfig: \n availabilityZoneCount: integer\n zoneAwarenessEnabled: boolean\ncognitoOptions: \n enabled: boolean\n identityPoolID: string\n roleARN: string\n userPoolID: string\ndomainEndpointOptions: \n customEndpoint: string\n customEndpointCertificateARN: string\n customEndpointEnabled: boolean\n enforceHTTPS: boolean\n tlsSecurityPolicy: string\nebsOptions: \n ebsEnabled: boolean\n iops: integer\n throughput: integer\n volumeSize: integer\n volumeType: string\nencryptionAtRestOptions: \n enabled: boolean\n kmsKeyID: string\nengineVersion: string\nlogPublishingOptions: {}\nname: string\nnodeToNodeEncryptionOptions: \n enabled: boolean\ntags:\n- key: string\n value: string\nvpcOptions: \n securityGroupIDs:\n - string\n subnetIDs:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIAM access policy as a JSON-formatted string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOption to allow references to indices in an HTTP request body. Must be false\u003cbr/\u003ewhen configuring access to individual sub-resources. By default, the value\u003cbr/\u003eis true. See Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies advanced security options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.anonymousAuthEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.internalUserDatabaseEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCredentials for the master user: username and password, ARN, or both.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities\u003cbr/\u003e(http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS\u003cbr/\u003eIdentity and Access Management for more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe SAML application configuration for the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe SAML identity povider\u0026rsquo;s information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp.entityID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp.metadataContent\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.masterBackendRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.masterUserName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.rolesKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.sessionTimeoutMinutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.subjectKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies Auto-Tune options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.desiredState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Auto-Tune desired state. Valid values are ENABLED and DISABLED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eService (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor more information.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe maintenance schedule duration: duration value and duration unit. See\u003cbr/\u003eAuto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration.unit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune\u003cbr/\u003efor Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eInteger to specify the value of a maintenance schedule duration. See Auto-Tune\u003cbr/\u003efor Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].startAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration options for a domain. Specifies the instance type and number\u003cbr/\u003eof instances in the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.coldStorageOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for cold storage options such as enabled\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.coldStorageOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe zone awareness configuration for the domain cluster, such as the number\u003cbr/\u003eof availability zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessConfig.availabilityZoneCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify the Cognito user and identity pools for OpenSearch Dashboards\u003cbr/\u003eauthentication. For more information, see Configuring Amazon Cognito authentication\u003cbr/\u003efor OpenSearch Dashboards (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.identityPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.userPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify configurations that will be applied to the domain endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpointCertificateARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities\u003cbr/\u003e(http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS\u003cbr/\u003eIdentity and Access Management for more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpointEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.enforceHTTPS\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.tlsSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to enable, disable, and specify the type and size of EBS storage\u003cbr/\u003evolumes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.ebsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.throughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based\u003cbr/\u003eStorage (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions for encryption of data at rest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eString of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine\u003cbr/\u003eversion for the Amazon OpenSearch Service domain. For example, \u0026ldquo;OpenSearch_1.0\u0026rdquo;\u003cbr/\u003eor \u0026ldquo;Elasticsearch_7.9\u0026rdquo;. For more information, see Creating and managing Amazon\u003cbr/\u003eOpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogPublishingOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap of LogType and LogPublishingOption, each containing options to publish\u003cbr/\u003ea given type of OpenSearch log.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon OpenSearch Service domain you\u0026rsquo;re creating. Domain\u003cbr/\u003enames are unique across the domains owned by an account within an AWS region.\u003cbr/\u003eDomain names must start with a lowercase letter and can contain the following\u003cbr/\u003echaracters: a-z (lowercase), 0-9, and - (hyphen).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeToNodeEncryptionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode-to-node encryption options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeToNodeEncryptionOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Tag added during domain creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key value pair for a resource tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string of length from 0 to 256 characters that specifies the value for\u003cbr/\u003ea tag. Tag values can be null and don\u0026rsquo;t have to be unique in a tag set.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify the subnets and security groups for a VPC endpoint. For\u003cbr/\u003emore information, see Launching your Amazon OpenSearch Service domains using\u003cbr/\u003ea VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nchangeProgressDetails: \n changeID: string\n message: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreated: boolean\ndeleted: boolean\ndomainID: string\nendpoint: string\nendpoints: {}\nprocessing: boolean\nserviceSoftwareOptions: \n automatedUpdateDate: string\n cancellable: boolean\n currentVersion: string\n description: string\n newVersion: string\n optionalDeployment: boolean\n updateAvailable: boolean\n updateStatus: string\nsnapshotOptions: \n automatedSnapshotStartHour: integer\nupgradeProcessing: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies change details of the domain configuration change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails.changeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe domain creation status. True if the creation of a domain is complete.\u003cbr/\u003eFalse if domain creation is still in progress.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe domain deletion status. True if a delete request has been received for\u003cbr/\u003ethe domain but resource cleanup is still in progress. False if the domain\u003cbr/\u003ehas not been deleted. Once domain deletion is complete, the status of the\u003cbr/\u003edomain is no longer returned.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the specified domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain endpoint that you use to submit index and search requests.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap containing the domain endpoints used to submit index and search requests.\u003cbr/\u003eExample key, value: \u0026lsquo;vpc\u0026rsquo;,\u0026lsquo;vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\u0026rsquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe status of the domain configuration. True if Amazon OpenSearch Service\u003cbr/\u003eis processing configuration changes. False if the configuration is active.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe current status of the domain\u0026rsquo;s service software.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.automatedUpdateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.cancellable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.currentVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.newVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.optionalDeployment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.updateAvailable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.updateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the SnapshotOptions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotOptions.automatedSnapshotStartHour\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupgradeProcessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe status of a domain version upgrade. True if Amazon OpenSearch Service\u003cbr/\u003eis undergoing a version upgrade. False if the configuration is active.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:89,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/domain/",title:"Domain",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Domain"\u003esagemaker-controller/apis/v1alpha1#Domain\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomainList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomains\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappNetworkAccessType: string\nappSecurityGroupManagement: string\nauthMode: string\ndefaultUserSettings: \n codeEditorAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n customFileSystemConfigs:\n efsFileSystemConfig: \n fileSystemID: string\n fileSystemPath: string\n customPosixUserConfig: \n gid: integer\n uid: integer\n defaultLandingURI: string\n executionRole: string\n jupyterLabAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n jupyterServerAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n kernelGatewayAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n rStudioServerProAppSettings: \n accessStatus: string\n userGroup: string\n securityGroups:\n - string\n sharingSettings: \n notebookOutputOption: string\n s3KMSKeyID: string\n s3OutputPath: string\n spaceStorageSettings: \n defaultEBSStorageSettings: \n defaultEBSVolumeSizeInGb: integer\n maximumEBSVolumeSizeInGb: integer\n studioWebPortal: string\n tensorBoardAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\ndomainName: string\ndomainSettings: \n dockerSettings: \n enableDockerAccess: string\n vpcOnlyTrustedAccounts:\n - string\n rStudioServerProDomainSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n domainExecutionRoleARN: string\n rStudioConnectURL: string\n rStudioPackageManagerURL: string\n securityGroupIDs:\n - string\nhomeEFSFileSystemKMSKeyID: string\nkmsKeyID: string\nsubnetIDs:\n- string\ntags:\n- key: string\n value: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappNetworkAccessType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon\u003cbr/\u003e SageMaker, which allows direct internet access\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * VpcOnly - All traffic is through the specified VPC and subnets\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSecurityGroupManagement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe entity that creates and manages the required security groups for inter-app\u003cbr/\u003ecommunication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType\u003cbr/\u003eis VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn\u003cbr/\u003eis provided. If setting up the domain for use with RStudio, this value must\u003cbr/\u003ebe set to Service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of authentication that members use to access the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default settings to use to create a user profile when UserSettings isn\u0026rsquo;t\u003cbr/\u003especified in the call to the CreateUserProfile API.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSecurityGroups is aggregated when specified in both calls. For all other\u003cbr/\u003esettings in UserSettings, the values specified in CreateUserProfile take\u003cbr/\u003eprecedence over those specified in CreateDomain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Code Editor application settings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Code Editor, see Get started with Code Editor\u003cbr/\u003ein Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom file system to a user profile or space\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor an Amazon SageMaker Domain. Permitted users can access this file system\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Amazon SageMaker Studio.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the POSIX identity that is used for file system operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig.gid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig.uid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.defaultLandingURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.executionRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for the JupyterLab application.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.rStudioServerProAppSettings.accessStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.rStudioServerProAppSettings.userGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.notebookOutputOption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.s3KMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default storage settings for a private space.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of default EBS storage settings that applies to private spaces\u003cbr/\u003ecreated within a domain or user profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.studioWebPortal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TensorBoard app settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of Domain settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings that configure the domain\u0026rsquo;s Docker interaction.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.enableDockerAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.vpcOnlyTrustedAccounts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.vpcOnlyTrustedAccounts.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.domainExecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.rStudioConnectURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.rStudioPackageManagerURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached\u003cbr/\u003eto the domain with an Amazon Web Services managed key by default. For more\u003cbr/\u003econtrol, specify a customer managed key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe VPC subnets that the domain uses for communication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for\u003cbr/\u003ecommunication. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndomainID: string\nstatus: string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eurl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL to the created domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:90,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/elasticipaddress/",title:"ElasticIPAddress",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#ElasticIPAddress"\u003eec2-controller/apis/v1alpha1#ElasticIPAddress\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eElasticIPAddress\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eElasticIPAddressList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eelasticipaddresses\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eelasticipaddress\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaddress: string\ncustomerOwnedIPv4Pool: string\nnetworkBorderGroup: string\npublicIPv4Pool: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address\u003cbr/\u003epool.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of a customer-owned address pool. Use this parameter to let Amazon\u003cbr/\u003eEC2 select an address from the address pool. Alternatively, specify a specific\u003cbr/\u003eaddress from the address pool.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique set of Availability Zones, Local Zones, or Wavelength Zones from\u003cbr/\u003ewhich Amazon Web Services advertises IP addresses. Use this parameter to\u003cbr/\u003elimit the IP address to this location. IP addresses cannot move between network\u003cbr/\u003eborder groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse DescribeAvailabilityZones (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html)\u003cbr/\u003eto view the network border groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use a network border group with EC2 Classic. If you attempt this\u003cbr/\u003eoperation on EC2 Classic, you receive an InvalidParameterCombination error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an address pool that you own. Use this parameter to let Amazon\u003cbr/\u003eEC2 select an address from the address pool. To specify a specific address\u003cbr/\u003efrom the address pool, use the Address parameter instead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallocationID: string\ncarrierIP: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncustomerOwnedIP: string\npublicIP: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation\u003cbr/\u003eof the Elastic IP address for use with instances in a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecarrierIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe carrier IP address. This option is only available for network interfaces\u003cbr/\u003ewhich reside in a subnet in a Wavelength Zone (for example an EC2 instance).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe customer-owned IP address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Elastic IP address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:91,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/endpoint/",title:"Endpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Endpoint"\u003eeventbridge-controller/apis/v1alpha1#Endpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA global endpoint used to improve your application\u0026rsquo;s availability by making\nit regional-fault tolerant. For more information about global endpoints,\nsee Making applications Regional-fault tolerant with global endpoints and\nevent replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html)\nin the Amazon EventBridge User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventBuses:\n- eventBusARN: string\nname: string\nreplicationConfig: \n state: string\nroleARN: string\nroutingConfig: \n failoverConfig: \n primary: \n healthCheck: string\n secondary: \n route: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the global endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBuses\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eDefine the event buses used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe names of the event buses must be identical in each Region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe event buses the endpoint is associated with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the global endpoint. For example, \u0026ldquo;Name\u0026rdquo;:\u0026ldquo;us-east-2-custom_bus_A-endpoint\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnable or disable event replication. The default state is ENABLED which means\u003cbr/\u003eyou must supply a RoleArn. If you don\u0026rsquo;t have a RoleArn or you don\u0026rsquo;t want\u003cbr/\u003eevent replication enabled, set the state to DISABLED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationConfig.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the role used for replication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigure the routing policy, including the health check and secondary Region..\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe failover configuration for an endpoint. This includes what triggers failover\u003cbr/\u003eand what happens when it\u0026rsquo;s triggered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.primary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe primary Region of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.primary.healthCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.secondary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe secondary Region that processes events when failover is triggered or\u003cbr/\u003ereplication is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.secondary.route\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstate: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the endpoint that was created by this request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the endpoint you asked for information about is in its current\u003cbr/\u003estate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:92,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/endpoint/",title:"Endpoint",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Endpoint"\u003esagemaker-controller/apis/v1alpha1#Endpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA hosted endpoint for real-time inference.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeploymentConfig: \n autoRollbackConfiguration: \n alarms:\n - alarmName: string\n blueGreenUpdatePolicy: \n maximumExecutionTimeoutInSeconds: integer\n terminationWaitInSeconds: integer\n trafficRoutingConfiguration: \n canarySize: \n type_: string\n value: integer\n linearStepSize: \n type_: string\n value: integer\n type_: string\n waitIntervalInSeconds: integer\n rollingUpdatePolicy: \n maximumBatchSize: \n type_: string\n value: integer\n maximumExecutionTimeoutInSeconds: integer\n rollbackMaximumBatchSize: \n type_: string\n value: integer\n waitIntervalInSeconds: integer\nendpointConfigName: string\nendpointName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment configuration for an endpoint, which contains the desired\u003cbr/\u003edeployment strategy and rollback configurations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAutomatic rollback configuration for handling endpoint deployment failures\u003cbr/\u003eand recovery.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration.alarms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration.alarms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Amazon CloudWatch alarm configured to monitor metrics on an endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUpdate policy for a blue/green deployment. If this update policy is specified,\u003cbr/\u003eSageMaker creates a new fleet during the deployment while maintaining the\u003cbr/\u003eold fleet. SageMaker flips traffic to the new fleet according to the specified\u003cbr/\u003etraffic routing configuration. Only one update policy should be used in the\u003cbr/\u003edeployment configuration. If no update policy is specified, SageMaker uses\u003cbr/\u003ea blue/green deployment strategy with all at once traffic shifting by default.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.maximumExecutionTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.terminationWaitInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the traffic routing strategy during an endpoint deployment to shift\u003cbr/\u003etraffic from the old fleet to the new fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.waitIntervalInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumBatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.rollingUpdatePolicy.maximumBatchSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumBatchSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumExecutionTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.waitIntervalInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an endpoint configuration. For more information, see CreateEndpointConfig\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the endpoint.The name must be unique within an Amazon Web Services\u003cbr/\u003eRegion in your Amazon Web Services account. The name is case-insensitive\u003cbr/\u003ein CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nendpointStatus: string\nfailureReason: string\nlastModifiedTime: string\npendingDeploymentSummary: \n endpointConfigName: string\n productionVariants:\n - acceleratorType: string\n currentInstanceCount: integer\n currentServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n currentWeight: number\n deployedImages:\n - resolutionTime: string\n resolvedImage: string\n specifiedImage: string\n desiredInstanceCount: integer\n desiredServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n desiredWeight: number\n instanceType: string\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n routingConfig: \n routingStrategy: string\n variantName: string\n variantStatus:\n - startTime: string\n status: string\n statusMessage: string\n startTime: string\nproductionVariants:\n- currentInstanceCount: integer\n currentServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n currentWeight: number\n deployedImages:\n - resolutionTime: string\n resolvedImage: string\n specifiedImage: string\n desiredInstanceCount: integer\n desiredServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n desiredWeight: number\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n routingConfig: \n routingStrategy: string\n variantName: string\n variantStatus:\n - startTime: string\n status: string\n statusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that shows when the endpoint was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OutOfService: Endpoint is not available to take incoming requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Creating: CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Updating: UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html)\u003cbr/\u003e or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SystemUpdating: Endpoint is undergoing maintenance and cannot be updated\u003cbr/\u003e or deleted or re-scaled until it has completed. This maintenance operation\u003cbr/\u003e does not change any customer-specified values such as VPC config, KMS\u003cbr/\u003e encryption, model, instance type, or instance count.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RollingBack: Endpoint fails to scale up or down or change its variant\u003cbr/\u003e weight and is in the process of rolling back to its previous configuration.\u003cbr/\u003e Once the rollback completes, endpoint returns to an InService status.\u003cbr/\u003e This transitional status only applies to an endpoint that has autoscaling\u003cbr/\u003e enabled and is undergoing variant weight or capacity changes as part of\u003cbr/\u003e an UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e operation is called explicitly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InService: Endpoint is available to process incoming requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Deleting: DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed: Endpoint could not be created, updated, or re-scaled. Use the\u003cbr/\u003e FailureReason value returned by DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html)\u003cbr/\u003e for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)\u003cbr/\u003e is the only operation that can be performed on a failed endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UpdateRollbackFailed: Both the rolling deployment and auto-rollback\u003cbr/\u003e failed. Your endpoint is in service with a mix of the old and new endpoint\u003cbr/\u003e configurations. For information about how to remedy this issue and restore\u003cbr/\u003e the endpoint\u0026rsquo;s status to InService, see Rolling Deployments (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the status of the endpoint is Failed, the reason why it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that shows when the endpoint was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns the summary of an in-progress deployment. This field is only returned\u003cbr/\u003ewhen the endpoint is creating or updating with a new endpoint configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.endpointConfigName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe production variant summary for a deployment when an endpoint is creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor updating with the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eoperations. Describes the VariantStatus , weight and capacity for a production\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003evariant associated with an endpoint.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentWeight\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eGets the Amazon EC2 Container Registry path of the docker image of the model\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you used the registry/repository[:tag] form to specify the image path\nof the primary container when you created the model hosted in this ProductionVariant,\nthe path resolves to a path of the form registry/repository[@digest]. A digest\nis a hash value that identifies a specific version of an image. For information\nabout Amazon ECR paths, see Pulling an Image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html)\nin the Amazon ECR User Guide. || \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].resolutionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].resolvedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].specifiedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the status of the production variant. || \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html)\u003cbr/\u003eobjects, one for each model hosted behind this endpoint. |\n| \u003cstrong\u003eproductionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes weight and capacities for a production variant associated with\nan endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\nAPI and the endpoint status is Updating, you get different desired and current\nvalues. || \u003cstrong\u003eproductionVariants.[].currentInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eGets the Amazon EC2 Container Registry path of the docker image of the model\nthat is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html).\u003c/p\u003e\n\u003cp\u003eIf you used the registry/repository[:tag] form to specify the image path\nof the primary container when you created the model hosted in this ProductionVariant,\nthe path resolves to a path of the form registry/repository[@digest]. A digest\nis a hash value that identifies a specific version of an image. For information\nabout Amazon ECR paths, see Pulling an Image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html)\nin the Amazon ECR User Guide. || \u003cstrong\u003eproductionVariants.[].deployedImages.[].resolutionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[].resolvedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[].specifiedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic. |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts. |\n| \u003cstrong\u003eproductionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the status of the production variant. || \u003cstrong\u003eproductionVariants.[].variantStatus.[].startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:93,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/endpointconfig/",title:"EndpointConfig",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#EndpointConfig"\u003esagemaker-controller/apis/v1alpha1#EndpointConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpointconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpointconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003easyncInferenceConfig: \n clientConfig: \n maxConcurrentInvocationsPerInstance: integer\n outputConfig: \n kmsKeyID: string\n notificationConfig: \n errorTopic: string\n includeInferenceResponseIn:\n - string\n successTopic: string\n s3FailurePath: string\n s3OutputPath: string\ndataCaptureConfig: \n captureContentTypeHeader: \n csvContentTypes:\n - string\n jsonContentTypes:\n - string\n captureOptions:\n - captureMode: string\n destinationS3URI: string\n enableCapture: boolean\n initialSamplingPercentage: integer\n kmsKeyID: string\nenableNetworkIsolation: boolean\nendpointConfigName: string\nexecutionRoleARN: string\nkmsKeyID: string\nproductionVariants:\n- acceleratorType: string\n containerStartupHealthCheckTimeoutInSeconds: integer\n coreDumpConfig: \n destinationS3URI: string\n kmsKeyID: string\n enableSSMAccess: boolean\n initialInstanceCount: integer\n initialVariantWeight: number\n instanceType: string\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n modelDataDownloadTimeoutInSeconds: integer\n modelName: string\n routingConfig: \n routingStrategy: string\n serverlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n variantName: string\n volumeSizeInGB: integer\ntags:\n- key: string\n value: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configuration for how an endpoint performs asynchronous inference.\u003cbr/\u003eThis is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.clientConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the behavior of the client used by SageMaker to interact with\u003cbr/\u003ethe model container during asynchronous inference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.clientConfig.maxConcurrentInvocationsPerInstance\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for asynchronous inference invocation outputs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for notifications of inference results for asynchronous\u003cbr/\u003einference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.errorTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.s3FailurePath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration to control how SageMaker captures inference data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration specifying how to treat different headers. If no headers are\u003cbr/\u003especified Amazon SageMaker will by default base64 encode when capturing the\u003cbr/\u003edata.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.csvContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.csvContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.jsonContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies data Model Monitor will capture.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.destinationS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.enableCapture\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.initialSamplingPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSets whether all model containers deployed to the endpoint are isolated.\u003cbr/\u003eIf they are, no inbound or outbound network calls can be made to or from\u003cbr/\u003ethe model containers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the endpoint configuration. You specify this name in a CreateEndpoint\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume\u003cbr/\u003eto perform actions on your behalf. For more information, see SageMaker Roles\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to Amazon SageMaker, the caller of this action\u003cbr/\u003emust have the iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service\u003cbr/\u003ekey that SageMaker uses to encrypt data on the storage volume attached to\u003cbr/\u003ethe ML compute instance that hosts the endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KmsKeyId can be any of the following formats:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias name: alias/ExampleAlias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key policy must grant permission to the IAM role that you specify\u003cbr/\u003ein your CreateEndpoint, UpdateEndpoint requests. For more information, refer\u003cbr/\u003eto the Amazon Web Services Key Management Service section Using Key Policies\u003cbr/\u003ein Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertain Nitro-based instances include local storage, dependent on the instance\u003cbr/\u003etype. Local storage volumes are encrypted using a hardware module on the\u003cbr/\u003einstance. You can\u0026rsquo;t request a KmsKeyId when using an instance type with local\u003cbr/\u003estorage. If any of the models that you specify in the ProductionVariants\u003cbr/\u003eparameter use nitro-based instances with local storage, do not specify a\u003cbr/\u003evalue for the KmsKeyId parameter. If you specify a value for KmsKeyId when\u003cbr/\u003eusing any nitro-based instances with local storage, the call to CreateEndpointConfig\u003cbr/\u003efails.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of instance types that support local instance storage, see Instance\u003cbr/\u003eStore Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about local instance storage encryption, see SSD Instance\u003cbr/\u003eStore Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of ProductionVariant objects, one for each model that you want to\u003cbr/\u003ehost at this endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies a model that you want to host and the resources chosen to deploy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor hosting it. If you are deploying multiple models, tell SageMaker how\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto distribute traffic among the models by specifying variant weights. For\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emore information on production variants, check Production variants (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].containerStartupHealthCheckTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configuration for a core dump from the model container when the\u003cbr/\u003eprocess crashes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig.destinationS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].enableSSMAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].initialInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].initialVariantWeight\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].modelDataDownloadTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].modelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:94,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/eventbus/",title:"EventBus",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#EventBus"\u003eeventbridge-controller/apis/v1alpha1#EventBus\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventBus\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventBusList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventbuses\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventbus\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn event bus receives events from a source, uses rules to evaluate them,\napplies any configured input transformation, and routes them to the appropriate\ntarget(s). Your account\u0026rsquo;s default event bus receives events from Amazon Web\nServices services. A custom event bus can receive events from your custom\napplications and services. A partner event bus receives events from an event\nsource created by an SaaS partner. These events come from the partners services\nor applications.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eeventSourceName: string\nname: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf you are creating a partner event bus, this specifies the partner event\u003cbr/\u003esource that the new event bus will be matched with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCustom event bus names can\u0026rsquo;t contain the / character, but you can use the\u003cbr/\u003e/ character in partner event bus names. In addition, for partner event buses,\u003cbr/\u003ethe name must exactly match the name of the partner event source that this\u003cbr/\u003eevent bus is matched to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t use the name default for a custom event bus, as this name is already\u003cbr/\u003eused for your account\u0026rsquo;s default event bus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to associate with the event bus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erules and event buses support tagging.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:95,href:"https://aws-controllers-k8s.github.io/community/reference/cloudtrail/v1alpha1/eventdatastore/",title:"EventDataStore",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudtrail.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudtrail-controller/apis/v1alpha1#EventDataStore"\u003ecloudtrail-controller/apis/v1alpha1#EventDataStore\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventDataStore\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventDataStoreList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventdatastores\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventdatastore\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA storage lake of event data against which you can run complex SQL-based\nqueries. An event data store can include events that you have logged on your\naccount from the last 90 to 2555 days (about three months to up to seven\nyears). To select events for an event data store, use advanced event selectors\n(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eadvancedEventSelectors:\n fieldSelectors:\n endsWith:\n - string\n equals:\n - string\n field: string\n notEndsWith:\n - string\n notEquals:\n - string\n notStartsWith:\n - string\n startsWith:\n - string\n name: string\nmultiRegionEnabled: boolean\nname: string\norganizationEnabled: boolean\nretentionPeriod: integer\ntags:\n- key: string\n value: string\nterminationProtectionEnabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedEventSelectors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe advanced event selectors to use to select the events for the data store.\u003cbr/\u003eFor more information about how to use advanced event selectors, see Log events\u003cbr/\u003eby using advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced)\u003cbr/\u003ein the CloudTrail User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedEventSelectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdvanced event selectors let you create fine-grained selectors for the following\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eCloudTrail event record fields. They help you control costs by logging only\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethose events that are important to you. For more information about advanced\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eevent selectors, see Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the CloudTrail User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003ereadOnly\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventSource\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventName\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventCategory\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eresources.type\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eresources.ARN\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou cannot apply both event selectors and advanced event selectors to a trail. || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single selector statement in an advanced event selector. || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].endsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].endsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].equals\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].equals.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].field\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEndsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEndsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEquals\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEquals.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notStartsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notStartsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].startsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].startsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emultiRegionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the event data store includes events from all regions,\u003cbr/\u003eor only from the region in which the event data store is created. |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the event data store. |\n| \u003cstrong\u003eorganizationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether an event data store collects events logged for an organization\u003cbr/\u003ein Organizations. |\n| \u003cstrong\u003eretentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe retention period of the event data store, in days. You can set a retention\u003cbr/\u003eperiod of up to 2555 days, the equivalent of seven years. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource such as a CloudTrail trail. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eterminationProtectionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether termination protection is enabled for the event data store.\u003cbr/\u003eIf termination protection is enabled, you cannot delete the event data store\u003cbr/\u003euntil termination protection is disabled. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedTimestamp: string\nstatus: string\nupdatedTimestamp: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that shows when the event data store was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of event data store creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdatedTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that shows when an event data store was updated, if applicable.\u003cbr/\u003eUpdatedTimestamp is always either the same or newer than the time shown in\u003cbr/\u003eCreatedTimestamp.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:96,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/eventsourcemapping/",title:"EventSourceMapping",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#EventSourceMapping"\u003elambda-controller/apis/v1alpha1#EventSourceMapping\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventSourceMapping\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventSourceMappingList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventsourcemappings\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventsourcemapping\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamazonManagedKafkaEventSourceConfig: \n consumerGroupID: string\nbatchSize: integer\nbisectBatchOnFunctionError: boolean\ndestinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\nenabled: boolean\neventSourceARN: string\neventSourceRef: \n from: \n name: string\nfilterCriteria: \n filters:\n - pattern: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nfunctionResponseTypes:\n- string\nmaximumBatchingWindowInSeconds: integer\nmaximumRecordAgeInSeconds: integer\nmaximumRetryAttempts: integer\nparallelizationFactor: integer\nqueueRefs:\n from: \n name: string\nqueues:\n- string\nscalingConfig: \n maximumConcurrency: integer\nselfManagedEventSource: \n endpoints: {}\nselfManagedKafkaEventSourceConfig: \n consumerGroupID: string\nsourceAccessConfigurations:\n- type_: string\n uRI: string\nstartingPosition: string\nstartingPositionTimestamp: string\ntopics:\n- string\ntumblingWindowInSeconds: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonManagedKafkaEventSourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecific configuration settings for an Amazon Managed Streaming for Apache\u003cbr/\u003eKafka (Amazon MSK) event source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonManagedKafkaEventSourceConfig.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of records in each batch that Lambda pulls from your stream\u003cbr/\u003eor queue and sends to your function. Lambda passes all of the records in\u003cbr/\u003ethe batch to the function in a single call, up to the payload limit for synchronous\u003cbr/\u003einvocation (6 MB).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Kinesis – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon DynamoDB Streams – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Simple Queue Service – Default 10. For standard queues the\u003cbr/\u003e max is 10,000. For FIFO queues the max is 10.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Self-managed Apache Kafka – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebisectBatchOnFunctionError\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e(Streams only) If the function returns an error, split the batch in two and\u003cbr/\u003eretry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded\u003cbr/\u003erecords.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhen true, the event source mapping is active. When false, Lambda pauses\u003cbr/\u003epolling and invocation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: True\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the event source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Kinesis – The ARN of the data stream or a stream consumer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon DynamoDB Streams – The ARN of the stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Simple Queue Service – The ARN of the queue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MQ – The ARN of the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that defines the filter criteria that determine whether Lambda\u003cbr/\u003eshould process an event. For more information, see Lambda event filtering\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria.filters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria.filters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure within a FilterCriteria object that defines an event filtering\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epattern.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it\u0026rsquo;s limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionResponseTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Streams and Amazon SQS) A list of current response type enums applied to\u003cbr/\u003ethe event source mapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionResponseTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) Discard records older than the specified age. The default\u003cbr/\u003evalue is infinite (-1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) Discard records after the specified number of retries. The\u003cbr/\u003edefault value is infinite (-1). When set to infinite (-1), failed records\u003cbr/\u003eare retried until the record expires.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) The number of batches to process from each shard concurrently.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **queueRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003equeueRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003equeues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(MQ) The name of the Amazon MQ broker destination queue to consume. |\n| \u003cstrong\u003equeues.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003escalingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Amazon SQS only) The scaling configuration for the event source. For more\u003cbr/\u003einformation, see Configuring maximum concurrency for Amazon SQS event sources\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). |\n| \u003cstrong\u003escalingConfig.maximumConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eselfManagedEventSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe self-managed Apache Kafka cluster to receive records from. |\n| \u003cstrong\u003eselfManagedEventSource.endpoints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eselfManagedKafkaEventSourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecific configuration settings for a self-managed Apache Kafka event source. |\n| \u003cstrong\u003eselfManagedKafkaEventSourceConfig.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esourceAccessConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of authentication protocols or VPC components required to secure\u003cbr/\u003eyour event source. |\n| \u003cstrong\u003esourceAccessConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTo secure and define access to your event source, you can specify the authentication\nprotocol, VPC components, or virtual host. || **sourceAccessConfigurations.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **sourceAccessConfigurations.[].uRI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **startingPosition**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe position in a stream from which to start reading. Required for Amazon\u003cbr/\u003eKinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is\u003cbr/\u003esupported only for Amazon Kinesis streams. |\n| **startingPositionTimestamp**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading. |\n| **topics**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eThe name of the Kafka topic. |\n| **topics.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **tumblingWindowInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e(Streams only) The duration in seconds of a processing window. The range\u003cbr/\u003eis between 1 second and 900 seconds. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfunctionARN: string\nlastModified: string\nlastProcessingResult: string\nstate: string\nstateTransitionReason: string\nuuid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date that the event source mapping was last updated or that its state\u003cbr/\u003echanged.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastProcessingResult\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe result of the last Lambda invocation of your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the event source mapping. It can be one of the following: Creating,\u003cbr/\u003eEnabling, Enabled, Disabling, Disabled, Updating, or Deleting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateTransitionReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether a user or Lambda made the last change to the event source\u003cbr/\u003emapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euuid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the event source mapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:97,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/fargateprofile/",title:"FargateProfile",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#FargateProfile"\u003eeks-controller/apis/v1alpha1#FargateProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFargateProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFargateProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efargateprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efargateprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Fargate profile.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nname: string\npodExecutionRoleARN: string\npodExecutionRoleRef: \n from: \n name: string\nselectors:\n labels: {}\n namespace: string\nsubnetRefs:\n from: \n name: string\nsubnets:\n- string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Fargate profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Pod execution role to use for a Pod\u003cbr/\u003ethat matches the selectors in the Fargate profile. The Pod execution role\u003cbr/\u003eallows Fargate infrastructure to register with your cluster as a node, and\u003cbr/\u003eit provides read access to Amazon ECR image repositories. For more information,\u003cbr/\u003esee Pod execution role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe selectors to match for a Pod to use this Fargate profile. Each selector\u003cbr/\u003emust have an associated Kubernetes namespace. Optionally, you can also specify\u003cbr/\u003elabels for a namespace. You may specify up to five selectors in a Fargate\u003cbr/\u003eprofile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing an Fargate profile selector.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IDs of subnets to launch a Pod into. A Pod running on Fargate isn\u0026rsquo;t assigned\u003cbr/\u003ea public IP address, so only private subnets (with no direct route to an\u003cbr/\u003eInternet Gateway) are accepted for this parameter. |\n| \u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the Fargate profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:98,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/featuregroup/",title:"FeatureGroup",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#FeatureGroup"\u003esagemaker-controller/apis/v1alpha1#FeatureGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFeatureGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFeatureGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efeaturegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efeaturegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon SageMaker Feature Store stores features in a collection called Feature\nGroup. A Feature Group can be visualized as a table which has rows, with\na unique identifier for each row where each column in the table is a feature.\nIn principle, a Feature Group is composed of features and values per features.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventTimeFeatureName: string\nfeatureDefinitions:\n collectionConfig: \n vectorConfig: \n dimension: integer\n collectionType: string\n featureName: string\n featureType: string\nfeatureGroupName: string\nofflineStoreConfig: \n dataCatalogConfig: \n catalog: string\n database: string\n tableName: string\n disableGlueTableCreation: boolean\n s3StorageConfig: \n kmsKeyID: string\n resolvedOutputS3URI: string\n s3URI: string\nonlineStoreConfig: \n enableOnlineStore: boolean\n securityConfig: \n kmsKeyID: string\n storageType: string\n ttlDuration: \n unit: string\n value: integer\nrecordIdentifierFeatureName: string\nroleARN: string\ntags:\n- key: string\n value: string\nthroughputConfig: \n provisionedReadCapacityUnits: integer\n provisionedWriteCapacityUnits: integer\n throughputMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA free-form description of a FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventTimeFeatureName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the feature that stores the EventTime of a Record in a FeatureGroup.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn EventTime is a point in time when a new event occurs that corresponds\u003cbr/\u003eto the creation or update of a Record in a FeatureGroup. All Records in the\u003cbr/\u003eFeatureGroup must have a corresponding EventTime.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn EventTime can be a String or Fractional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Fractional: EventTime feature values must be a Unix timestamp in seconds.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * String: EventTime feature values must be an ISO-8601 string in the format.\u003cbr/\u003e The following formats are supported yyyy-MM-dd\u0026rsquo;T\u0026rsquo;HH:mm:ssZ and yyyy-MM-dd\u0026rsquo;T\u0026rsquo;HH:mm:ss.SSSZ\u003cbr/\u003e where yyyy, MM, and dd represent the year, month, and day respectively\u003cbr/\u003e and HH, mm, ss, and if applicable, SSS represent the hour, month, second\u003cbr/\u003e and milliseconds respsectively. \u0026lsquo;T\u0026rsquo; and Z are constants.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Feature names and types. Name and Type is compulsory per Feature.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid feature FeatureTypes are Integral, Fractional and String.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create up to 2,500 FeatureDefinitions per FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of features. You must include FeatureName and FeatureType. Valid feature\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eFeatureTypes are Integral, Fractional and String.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionConfig.vectorConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for your vector collection type.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionConfig.vectorConfig.dimension\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].featureName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].featureType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the FeatureGroup. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. The name:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must start and end with an alphanumeric character.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can only contain alphanumeric character and hyphens. Spaces are not\u003cbr/\u003e allowed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUse this to configure an OfflineFeatureStore. This parameter allows you to\u003cbr/\u003especify:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration for an Amazon Web Services Glue or Amazon Web Services\u003cbr/\u003e Hive data catalog.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore.\u003cbr/\u003e If KMS encryption key is not specified, by default we encrypt all data\u003cbr/\u003e at rest using Amazon Web Services KMS key. By defining your bucket-level\u003cbr/\u003e key (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html)\u003cbr/\u003e for SSE, you can reduce Amazon Web Services KMS requests costs by up to\u003cbr/\u003e 99 percent.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Format for the offline store table. Supported formats are Glue (Default)\u003cbr/\u003e and Apache Iceberg (https://iceberg.apache.org/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn more about this parameter, see OfflineStoreConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe meta data of the Glue table which serves as data catalog for the OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.catalog\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.tableName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.disableGlueTableCreation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Amazon Simple Storage (Amazon S3) location and and security configuration\u003cbr/\u003efor OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.resolvedOutputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eYou can turn the OnlineStore on or off by specifying True for the EnableOnlineStore\u003cbr/\u003eflag in OnlineStoreConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest\u003cbr/\u003eencryption of the OnlineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is False.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.enableOnlineStore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.securityConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe security configuration for OnlineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.securityConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.storageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTime to live duration, where the record is hard deleted after the expiration\u003cbr/\u003etime is reached; ExpiresAt = EventTime + TtlDuration. For information on\u003cbr/\u003eHardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html)\u003cbr/\u003eAPI in the Amazon SageMaker API Reference guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration.unit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erecordIdentifierFeatureName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Feature whose value uniquely identifies a Record defined\u003cbr/\u003ein the FeatureStore. Only the latest record per identifier value will be\u003cbr/\u003estored in the OnlineStore. RecordIdentifierFeatureName must be one of feature\u003cbr/\u003edefinitions\' names.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou use the RecordIdentifierFeatureName to access data in a FeatureStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis name:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must start and end with an alphanumeric character.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can only contains alphanumeric characters, hyphens, underscores. Spaces\u003cbr/\u003e are not allowed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM execution role used to persist\u003cbr/\u003edata into the OfflineStore if an OfflineStoreConfig is provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags used to identify Features in each FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed to set feature group throughput configuration. There are two modes:\u003cbr/\u003eON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data\u003cbr/\u003ereads and writes that your application performs on your feature group. You\u003cbr/\u003edo not need to specify read and write throughput because Feature Store accommodates\u003cbr/\u003eyour workloads as they ramp up and down. You can switch a feature group to\u003cbr/\u003eon-demand only once in a 24 hour period. With provisioned throughput mode,\u003cbr/\u003eyou specify the read and write capacity per second that you expect your application\u003cbr/\u003eto require, and you are billed based on those limits. Exceeding provisioned\u003cbr/\u003ethroughput will result in your requests being throttled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: PROVISIONED throughput mode is supported only for feature groups that\u003cbr/\u003eare offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType)\u003cbr/\u003etier online store. |\n| \u003cstrong\u003ethroughputConfig.provisionedReadCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig.provisionedWriteCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig.throughputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nfeatureGroupStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason that the FeatureGroup failed to be replicated in the OfflineStore.\u003cbr/\u003eThis is failure can occur because:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The FeatureGroup could not be created in the OfflineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The FeatureGroup could not be deleted from the OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the feature group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:99,href:"https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/fieldexport/",title:"FieldExport",description:null,content:'\u003cp\u003e\u003ccode\u003eservices.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1#FieldExport"\u003eruntime/apis/core/v1alpha1#FieldExport\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFieldExportList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efieldexports\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efieldexport\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efrom: \n path: string\n resource: \n group: string\n kind: string\n name: string\nto: \n key: string\n kind: string\n name: string\n namespace: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eResourceFieldSelector provides the values necessary to identify an individual\u003cbr/\u003efield on an individual K8s resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.path\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNamespacedResource provides all the values necessary to identify an ACK\u003cbr/\u003eresource of a given type (within the same namespace as the custom resource\u003cbr/\u003econtaining this type).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.group\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.name\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFieldExportTarget provides the values necessary to identify the\u003cbr/\u003eoutput path for a field export.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey overrides the default value (\u003ccode\u003e\u0026lt;namespace\u0026gt;.\u0026lt;FieldExport-resource-name\u0026gt;\u003c/code\u003e) for the FieldExport target\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFieldExportOutputType represents all types that can be produced by a field\u003cbr/\u003eexport operation\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.name\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNamespace is marked as optional, so we cannot compose \u003ccode\u003eNamespacedName\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various\u003cbr/\u003erecoverable states of the field CR\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:100,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/filesystem/",title:"FileSystem",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#FileSystem"\u003eefs-controller/apis/v1alpha1#FileSystem\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFileSystem\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFileSystemList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efilesystems\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efilesystem\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eavailabilityZoneName: string\nbackup: boolean\nbackupPolicy: \n status: string\nencrypted: boolean\nfileSystemProtection: \n replicationOverwriteProtection: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nlifecyclePolicies:\n- transitionToArchive: string\n transitionToIA: string\n transitionToPrimaryStorageClass: string\nperformanceMode: string\npolicy: string\nprovisionedThroughputInMiBps: number\ntags:\n- key: string\n value: string\nthroughputMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUsed to create a One Zone file system. It specifies the Amazon Web Services\u003cbr/\u003eAvailability Zone in which to create the file system. Use the format us-east-1a\u003cbr/\u003eto specify the Availability Zone. For more information about One Zone file\u003cbr/\u003esystems, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOne Zone file systems are not available in all Availability Zones in Amazon\u003cbr/\u003eWeb Services Regions where Amazon EFS is available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether automatic backups are enabled on the file system that you\u003cbr/\u003eare creating. Set the value to true to enable automatic backups. If you are\u003cbr/\u003ecreating a One Zone file system, automatic backups are enabled by default.\u003cbr/\u003eFor more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is false. However, if you specify an AvailabilityZoneName, the default\u003cbr/\u003eis true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBackup is not available in all Amazon Web Services Regions where Amazon EFS\u003cbr/\u003eis available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe backup policy included in the PutBackupPolicy request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupPolicy.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA Boolean value that, if true, creates an encrypted file system. When creating\u003cbr/\u003ean encrypted file system, you have the option of specifying an existing Key\u003cbr/\u003eManagement Service key (KMS key). If you don\u0026rsquo;t specify a KMS key, then the\u003cbr/\u003edefault KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect\u003cbr/\u003ethe encrypted file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemProtection.replicationOverwriteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key that you want to use to protect the encrypted file\u003cbr/\u003esystem. This parameter is required only if you want to use a non-default\u003cbr/\u003eKMS key. If this parameter is not specified, the default KMS key for Amazon\u003cbr/\u003eEFS is used. You can specify a KMS key ID using the following formats:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key alias - A previously created display name for a key, for example\u003cbr/\u003e alias/projectKey1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter\u003cbr/\u003eto true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with\u003cbr/\u003eAmazon EFS file systems.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of LifecyclePolicy objects that define the file system\u0026rsquo;s LifecycleConfiguration\u003cbr/\u003eobject. A LifecycleConfiguration object informs EFS Lifecycle management\u003cbr/\u003eof the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToIA – When to move files in the file system from primary\u003cbr/\u003e storage (Standard storage class) into the Infrequent Access (IA) storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToArchive – When to move files in the file system from their\u003cbr/\u003e current storage class (either IA or Standard storage) into the Archive\u003cbr/\u003e storage. File systems cannot transition into Archive storage before transitioning\u003cbr/\u003e into IA storage. Therefore, TransitionToArchive must either not be set\u003cbr/\u003e or must be later than TransitionToIA. The Archive storage class is available\u003cbr/\u003e only for file systems that use the Elastic Throughput mode and the General\u003cbr/\u003e Purpose Performance mode.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToPrimaryStorageClass – Whether to move files in the file\u003cbr/\u003e system back to primary storage (Standard storage class) after they are\u003cbr/\u003e accessed in IA or Archive storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration\u003cbr/\u003eAPI action, Amazon EFS requires that each LifecyclePolicy object have only\u003cbr/\u003ea single transition. This means that in a request body, LifecyclePolicies\u003cbr/\u003emust be structured as an array of LifecyclePolicy objects, one object for\u003cbr/\u003eeach storage transition. See the example requests in the following section\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a policy used by Lifecycle management that specifies when to transition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efiles into and out of storage classes. For more information, see Managing\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system storage (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration\nAPI action, Amazon EFS requires that each LifecyclePolicy object have only\na single transition. This means that in a request body, LifecyclePolicies\nmust be structured as an array of LifecyclePolicy objects, one object for\neach transition. For more information, see the request examples in PutLifecycleConfiguration. || \u003cstrong\u003elifecyclePolicies.[].transitionToArchive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecyclePolicies.[].transitionToIA\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecyclePolicies.[].transitionToPrimaryStorageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eperformanceMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Performance mode of the file system. We recommend generalPurpose performance\u003cbr/\u003emode for all file systems. File systems using the maxIO performance mode\u003cbr/\u003ecan scale to higher levels of aggregate throughput and operations per second\u003cbr/\u003ewith a tradeoff of slightly higher latencies for most file operations. The\u003cbr/\u003eperformance mode can\u0026rsquo;t be changed after the file system has been created.\u003cbr/\u003eThe maxIO mode is not supported on One Zone file systems.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDue to the higher per-operation latencies with Max I/O, we recommend using\u003cbr/\u003eGeneral Purpose performance mode for all file systems.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is generalPurpose. |\n| \u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe FileSystemPolicy that you\u0026rsquo;re creating. Accepts a JSON formatted policy\u003cbr/\u003edefinition. EFS file system policies have a 20,000 character limit. To find\u003cbr/\u003eout more about the elements that make up a file system policy, see EFS Resource-based\u003cbr/\u003ePolicies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). |\n| \u003cstrong\u003eprovisionedThroughputInMiBps\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003eThe throughput, measured in mebibytes per second (MiBps), that you want to\u003cbr/\u003eprovision for a file system that you\u0026rsquo;re creating. Required if ThroughputMode\u003cbr/\u003eis set to provisioned. Valid values are 1-3414 MiBps, with the upper limit\u003cbr/\u003edepending on Region. To increase this limit, contact Amazon Web Services\u003cbr/\u003eSupport. For more information, see Amazon EFS quotas that you can increase\u003cbr/\u003e(https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the\u003cbr/\u003eAmazon EFS User Guide. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eUse to create one or more tags associated with the file system. Each tag\u003cbr/\u003eis a user-defined key-value pair. Name your file system on creation by including\u003cbr/\u003ea \u0026ldquo;Key\u0026rdquo;:\u0026ldquo;Name\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026quot;{value}\u0026quot; key-value pair. Each key must be unique.\u003cbr/\u003eFor more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag is a key-value pair. Allowed characters are letters, white space, and\nnumbers that can be represented in UTF-8, and the following characters:+\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e= . _ : /. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the throughput mode for the file system. The mode can be bursting,\u003cbr/\u003eprovisioned, or elastic. If you set ThroughputMode to provisioned, you must\u003cbr/\u003ealso set a value for ProvisionedThroughputInMibps. After you create the file\u003cbr/\u003esystem, you can decrease your file system\u0026rsquo;s Provisioned throughput or change\u003cbr/\u003ebetween the throughput modes, with certain time restrictions. For more information,\u003cbr/\u003esee Specifying throughput with provisioned mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is bursting. |\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZoneID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfileSystemID: string\nlifeCycleState: string\nname: string\nnumberOfMountTargets: integer\nownerID: string\nsizeInBytes: \n timestamp: string\n value: integer\n valueInArchive: integer\n valueInIA: integer\n valueInStandard: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique and consistent identifier of the Availability Zone in which the\u003cbr/\u003efile system is located, and is valid only for One Zone file systems. For\u003cbr/\u003eexample, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web\u003cbr/\u003eServices Region, and it has the same location in every Amazon Web Services\u003cbr/\u003eaccount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the file system, assigned by Amazon EFS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe lifecycle phase of the file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eYou can add tags to a file system, including a Name tag. For more information,\u003cbr/\u003esee CreateFileSystem. If the file system has a Name tag, Amazon EFS returns\u003cbr/\u003ethe value in this field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfMountTargets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current number of mount targets that the file system has. For more information,\u003cbr/\u003esee CreateMountTarget.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account that created the file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe latest known metered size (in bytes) of data stored in the file system,\u003cbr/\u003ein its Value field, and the time at which that size was determined in its\u003cbr/\u003eTimestamp field. The Timestamp value is the integer number of seconds since\u003cbr/\u003e1970-01-01T00:00:00Z. The SizeInBytes value doesn\u0026rsquo;t represent the size of\u003cbr/\u003ea consistent snapshot of the file system, but it is eventually consistent\u003cbr/\u003ewhen there are no writes to the file system. That is, SizeInBytes represents\u003cbr/\u003eactual size only if the file system is not modified for a period longer than\u003cbr/\u003ea couple of hours. Otherwise, the value is not the exact size that the file\u003cbr/\u003esystem was at any point in time.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.timestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInArchive\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInIA\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInStandard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:101,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/firewall/",title:"Firewall",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#Firewall"\u003enetworkfirewall-controller/apis/v1alpha1#Firewall\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewall\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewalls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewall\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe firewall defines the configuration settings for an Network Firewall firewall.\nThese settings include the firewall policy, the subnets in your VPC to use\nfor the firewall endpoints, and any tags that are attached to the firewall\nAmazon Web Services resource.\u003c/p\u003e\n\u003cp\u003eThe status of the firewall, for example whether it\u0026rsquo;s ready to filter network\ntraffic, is provided in the corresponding FirewallStatus. You can retrieve\nboth objects by calling DescribeFirewall.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeleteProtection: boolean\ndescription: string\nencryptionConfiguration: \n keyID: string\n type_: string\nfirewallName: string\nfirewallPolicyARN: string\nfirewallPolicyChangeProtection: boolean\nsubnetChangeProtection: boolean\nsubnetMappings:\n- iPAddressType: string\n subnetID: string\ntags:\n- key: string\n value: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating whether it is possible to delete the firewall. A setting\u003cbr/\u003eof TRUE indicates that the firewall is protected against deletion. Use this\u003cbr/\u003esetting to protect against accidentally deleting a firewall that is in use.\u003cbr/\u003eWhen you create a firewall, the operation initializes this flag to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your firewall resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the firewall. You can\u0026rsquo;t change the name of a firewall\u003cbr/\u003eafter you create it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the FirewallPolicy that you want to use\u003cbr/\u003efor the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA setting indicating whether the firewall is protected against a change to\u003cbr/\u003ethe firewall policy association. Use this setting to protect against accidentally\u003cbr/\u003emodifying the firewall policy for a firewall that is in use. When you create\u003cbr/\u003ea firewall, the operation initializes this setting to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA setting indicating whether the firewall is protected against changes to\u003cbr/\u003ethe subnet associations. Use this setting to protect against accidentally\u003cbr/\u003emodifying the subnet associations for a firewall that is in use. When you\u003cbr/\u003ecreate a firewall, the operation initializes this setting to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe public subnets to use for your Network Firewall firewalls. Each subnet\u003cbr/\u003emust belong to a different Availability Zone in the VPC. Network Firewall\u003cbr/\u003ecreates a firewall endpoint in each subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID for a subnet that you want to associate with the firewall. This is\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eused with CreateFirewall and AssociateSubnets. Network Firewall creates an\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einstance of the associated firewall in each subnet that you specify, to filter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etraffic in the subnet\u0026rsquo;s Availability Zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier of the VPC where Network Firewall should create the\u003cbr/\u003efirewall.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t change this setting after you create the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfirewall: \n deleteProtection: boolean\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n firewallARN: string\n firewallID: string\n firewallName: string\n firewallPolicyARN: string\n firewallPolicyChangeProtection: boolean\n subnetChangeProtection: boolean\n subnetMappings:\n - iPAddressType: string\n subnetID: string\n tags:\n - key: string\n value: string\n vpcID: string\nfirewallStatus: \n capacityUsageSummary: \n cidrs: \n availableCIDRCount: integer\n iPSetReferences: {}\n utilizedCIDRCount: integer\n configurationSyncStateSummary: string\n status: string\n syncStates: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration settings for the firewall. These settings include the firewall\u003cbr/\u003epolicy and the subnets in your VPC to use for the firewall endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.deleteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**firewall.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallPolicyChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID for a subnet that you want to associate with the firewall. This is\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eused with CreateFirewall and AssociateSubnets. Network Firewall creates an\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einstance of the associated firewall in each subnet that you specify, to filter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etraffic in the subnet\u0026rsquo;s Availability Zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about the current status of a Firewall. You can retrieve\u003cbr/\u003ethis for a firewall by calling DescribeFirewall and providing the firewall\u003cbr/\u003ename and ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe capacity usage summary of the resources used by the ReferenceSets in\u003cbr/\u003ea firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSummarizes the CIDR blocks used by the IP set references in a firewall. Network\u003cbr/\u003eFirewall calculates the number of CIDRs by taking an aggregated count of\u003cbr/\u003eall CIDRs used by the IP sets you are referencing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.availableCIDRCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.iPSetReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.utilizedCIDRCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.configurationSyncStateSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.syncStates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:102,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/firewallpolicy/",title:"FirewallPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#FirewallPolicy"\u003enetworkfirewall-controller/apis/v1alpha1#FirewallPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewallpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewallpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe firewall policy defines the behavior of a firewall using a collection\nof stateless and stateful rule groups and other settings. You can use one\nfirewall policy for multiple firewalls.\u003c/p\u003e\n\u003cp\u003eThis, along with FirewallPolicyResponse, define the policy. You can retrieve\nall objects for a firewall policy by calling DescribeFirewallPolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nencryptionConfiguration: \n keyID: string\n type_: string\nfirewallPolicy: \n policyVariables: \n ruleVariables: {}\n statefulDefaultActions:\n - string\n statefulEngineOptions: \n ruleOrder: string\n streamExceptionPolicy: string\n statefulRuleGroupReferences:\n override: \n action: string\n priority: integer\n resourceARN: string\n statelessCustomActions:\n actionDefinition: \n publishMetricAction: \n dimensions:\n - value: string\n actionName: string\n statelessDefaultActions:\n - string\n statelessFragmentDefaultActions:\n - string\n statelessRuleGroupReferences:\n - priority: integer\n resourceARN: string\n tlsInspectionConfigurationARN: string\nfirewallPolicyName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your firewall policy\u003cbr/\u003eresources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe rule groups and policy actions to use in the firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.policyVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains variables that you can use to override default Suricata settings\u003cbr/\u003ein your firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.policyVariables.ruleVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulEngineOptions.ruleOrder\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulEngineOptions.streamExceptionPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifier for a single stateful rule group, used in a firewall policy to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erefer to a rule group.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].override.action\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].resourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statelessCustomActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statelessCustomActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn optional, non-standard action to use for stateless packet handling. You\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan define this in addition to the standard action that you must specify.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou define and name the custom actions that you want to be able to use, and\nthen you reference them by name in your actions settings.\u003c/p\u003e\n\u003cp\u003eYou can use custom actions in the following places:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eIn a rule group\u0026rsquo;s StatelessRulesAndCustomActions specification. The\ncustom actions are available for use by name inside the StatelessRulesAndCustomActions\nwhere you define them. You can use them for your stateless rule actions\nto specify what to do with a packet that matches the rule\u0026rsquo;s match attributes.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIn a FirewallPolicy specification, in StatelessCustomActions. The custom\nactions are available for use inside the policy where you define them.\nYou can use them for the policy\u0026rsquo;s default stateless actions settings to\nspecify what to do with packets that don\u0026rsquo;t match any of the policy\u0026rsquo;s stateless\nrules. || \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom action to use in stateless rule actions settings. This is used in\u003cbr/\u003eCustomAction. |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateless inspection criteria that publishes the specified metrics to Amazon\u003cbr/\u003eCloudWatch for the matching packet. This setting defines a CloudWatch dimension\u003cbr/\u003evalue to be published. |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe value to use in an Amazon CloudWatch custom metric dimension. This is\nused in the PublishMetrics CustomAction. A CloudWatch custom metric dimension\nis a name/value pair that\u0026rsquo;s part of the identity of a metric.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eNetwork Firewall sets the dimension name to CustomAction and you provide\nthe dimension value.\u003c/p\u003e\n\u003cp\u003eFor more information about CloudWatch custom metric dimensions, see Publishing\nCustom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions)\nin the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). || \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003efirewallPolicy.statelessFragmentDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessFragmentDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifier for a single stateless rule group, used in a firewall policy to\nrefer to the rule group. || \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[].resourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.tlsInspectionConfigurationARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicyName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the firewall policy. You can\u0026rsquo;t change the name of\u003cbr/\u003ea firewall policy after you create it. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\npair can be anything you define. Typically, the tag key represents a category\n(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\nthat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\nup to 50 tags to each Amazon Web Services resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfirewallPolicyResponse: \n consumedStatefulRuleCapacity: integer\n consumedStatelessRuleCapacity: integer\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n firewallPolicyARN: string\n firewallPolicyID: string\n firewallPolicyName: string\n firewallPolicyStatus: string\n lastModifiedTime: string\n numberOfAssociations: integer\n tags:\n - key: string\n value: string\nupdateToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe high-level properties of a firewall policy. This, along with the FirewallPolicy,\u003cbr/\u003edefine the policy. You can retrieve all objects for a firewall policy by\u003cbr/\u003ecalling DescribeFirewallPolicy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.consumedStatefulRuleCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.consumedStatelessRuleCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**firewallPolicyResponse.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.numberOfAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA token used for optimistic locking. Network Firewall returns a token to\u003cbr/\u003eyour requests that access the firewall policy. The token marks the state\u003cbr/\u003eof the policy resource at the time of the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo make changes to the policy, you provide the token in your request. Network\u003cbr/\u003eFirewall uses the token to ensure that the policy hasn\u0026rsquo;t changed since you\u003cbr/\u003elast retrieved it. If it has changed, the operation fails with an InvalidTokenException.\u003cbr/\u003eIf this happens, retrieve the firewall policy again to get a current copy\u003cbr/\u003eof it with current token. Reapply your changes as needed, then try the operation\u003cbr/\u003eagain using the new token.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:103,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/flowlog/",title:"FlowLog",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#FlowLog"\u003eec2-controller/apis/v1alpha1#FlowLog\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFlowLog\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFlowLogList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eflowlogs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eflowlog\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a flow log.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeliverLogsPermissionARN: string\ndestinationOptions: \n fileFormat: string\n hiveCompatiblePartitions: boolean\n perHourPartition: boolean\nlogDestination: string\nlogDestinationType: string\nlogFormat: string\nlogGroupName: string\nmaxAggregationInterval: integer\nresourceID: string\nresourceType: string\ntags:\n- key: string\n value: string\ntrafficType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliverLogsPermissionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to\u003cbr/\u003ea CloudWatch Logs log group in your account.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe destination options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.fileFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.hiveCompatiblePartitions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.perHourPartition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDestination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe destination to which the flow log data is to be published. Flow log data\u003cbr/\u003ecan be published to a CloudWatch Logs log group or an Amazon S3 bucket. The\u003cbr/\u003evalue specified for this parameter depends on the value specified for LogDestinationType.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf LogDestinationType is not specified or cloud-watch-logs, specify the Amazon\u003cbr/\u003eResource Name (ARN) of the CloudWatch Logs log group. For example, to publish\u003cbr/\u003eto a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs.\u003cbr/\u003eAlternatively, use LogGroupName instead.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You\u003cbr/\u003ecan also specify a subfolder in the bucket. To specify a subfolder in the\u003cbr/\u003ebucket, use the following ARN format: bucket_ARN/subfolder_name/. For example,\u003cbr/\u003eto specify a subfolder named my-logs in a bucket named my-bucket, use the\u003cbr/\u003efollowing ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as\u003cbr/\u003ea subfolder name. This is a reserved term.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDestinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of destination to which the flow log data is to be published. Flow\u003cbr/\u003elog data can be published to CloudWatch Logs or Amazon S3. To publish flow\u003cbr/\u003elog data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log\u003cbr/\u003edata to Amazon S3, specify s3.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: cloud-watch-logs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe fields to include in the flow log record, in the order in which they\u003cbr/\u003eshould appear. For a list of available fields, see Flow log records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records).\u003cbr/\u003eIf you omit this parameter, the flow log is created using the default format.\u003cbr/\u003eIf you specify this parameter, you must specify at least one field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the fields using the ${field-id} format, separated by spaces. For\u003cbr/\u003ethe CLI, surround this parameter value with single quotes on Linux or double\u003cbr/\u003equotes on Windows.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of a new or existing CloudWatch Logs log group where Amazon EC2\u003cbr/\u003epublishes your flow logs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxAggregationInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum interval of time during which a flow of packets is captured and\u003cbr/\u003eaggregated into a flow log record. You can specify 60 seconds (1 minute)\u003cbr/\u003eor 600 seconds (10 minutes).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a network interface is attached to a Nitro-based instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances),\u003cbr/\u003ethe aggregation interval is always 60 seconds or less, regardless of the\u003cbr/\u003evalue that you specify.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 600\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of resource for which to create the flow log. For example, if you\u003cbr/\u003especified a VPC ID for the ResourceId property, specify VPC for this property.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etrafficType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of traffic to log. You can log traffic that the resource accepts\u003cbr/\u003eor rejects, or all traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclientToken: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nflowLogID: string\nunsuccessful:\n error: \n code: string\n message: string\n resourceID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eflowLogID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the flow logs that could not be created successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about items that were not successfully processed in a batch call.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].error.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].resourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:104,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/function/",title:"Function",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#Function"\u003ecloudfront-controller/apis/v1alpha1#Function\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efunctionCode: string\nfunctionConfig: \n comment: string\n runtime: string\nname: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionCode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function code. For more information about writing a CloudFront function,\u003cbr/\u003esee Writing function code for CloudFront Functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information about the function, including an optional comment\u003cbr/\u003eand the function\u0026rsquo;s runtime.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig.runtime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name to identify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nfunctionSummary: \n functionConfig: \n comment: string\n runtime: string\n functionMetadata: \n createdTime: string\n functionARN: string\n lastModifiedTime: string\n stage: string\n name: string\n status: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version identifier for the current version of the CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information and metadata about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig.runtime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains metadata about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.createdTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.functionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.stage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL of the CloudFront function. Use the URL to manage the function with\u003cbr/\u003ethe CloudFront API.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:105,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/function/",title:"Function",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Function"\u003elambda-controller/apis/v1alpha1#Function\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003earchitectures:\n- string\ncode: \n imageURI: string\n s3Bucket: string\n s3BucketRef: \n from: \n name: string\n s3Key: string\n s3ObjectVersion: string\n zipFile: string\ncodeSigningConfigARN: string\ndeadLetterConfig: \n targetARN: string\ndescription: string\nenvironment: \n variables: {}\nephemeralStorage: \n size: integer\nfileSystemConfigs:\n- arn: string\n localMountPath: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nhandler: string\nimageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nkmsKeyARN: string\nkmsKeyRef: \n from: \n name: string\nlayers:\n- string\nmemorySize: integer\nname: string\npackageType: string\npublish: boolean\nreservedConcurrentExecutions: integer\nrole: string\nroleRef: \n from: \n name: string\nruntime: string\nsnapStart: \n applyOn: string\ntags: {}\ntimeout: integer\ntracingConfig: \n mode: string\nvpcConfig: \n securityGroupIDs:\n - string\n securityGroupRefs:\n from: \n name: string\n subnetIDs:\n - string\n subnetRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe instruction set architecture that the function supports. Enter a string\u003cbr/\u003earray with one of the valid values (arm64 or x86_64). The default value is\u003cbr/\u003ex86_64.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3Bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for S3Bucket\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3Key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3ObjectVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.zipFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTo enable code signing for this function, specify the ARN of a code-signing\u003cbr/\u003econfiguration. A code-signing configuration includes a set of signing profiles,\u003cbr/\u003ewhich define the trusted publishers for this function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dead-letter queue configuration that specifies the queue or topic where\u003cbr/\u003eLambda sends asynchronous events when they fail processing. For more information,\u003cbr/\u003esee Dead-letter queues (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig.targetARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnvironment variables that are accessible from function code during execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.variables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe size of the function\u0026rsquo;s /tmp directory in MB. The default value is 512,\u003cbr/\u003ebut can be any whole number between 512 and 10,240 MB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConnection settings for an Amazon EFS file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the connection between a Lambda function and an Amazon EFS\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[].localMountPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures options for asynchronous invocation on a function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- DestinationConfig\u003cbr/\u003eA destination for events after they have been sent to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypes of Destinations:\u003cbr/\u003eFunction - The Amazon Resource Name (ARN) of a Lambda function.\u003cbr/\u003eQueue - The ARN of a standard SQS queue.\u003cbr/\u003eTopic - The ARN of a standard SNS topic.\u003cbr/\u003eEvent Bus - The ARN of an Amazon EventBridge event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumEventAgeInSeconds\u003cbr/\u003eThe maximum age of a request that Lambda sends to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumRetryAttempts\u003cbr/\u003eThe maximum number of times to retry when the function returns an error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehandler\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the method within your code that Lambda calls to run your function.\u003cbr/\u003eHandler is required if the deployment package is a .zip file archive. The\u003cbr/\u003eformat includes the file name. It can also include namespaces and other qualifiers,\u003cbr/\u003edepending on the runtime. For more information, see Lambda programming model\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings)\u003cbr/\u003ethat override the values in the container image Dockerfile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the Key Management Service (KMS) key that\u0026rsquo;s used to encrypt your\u003cbr/\u003efunction\u0026rsquo;s environment variables. If it\u0026rsquo;s not provided, Lambda uses a default\u003cbr/\u003eservice key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\u003cbr/\u003eto add to the function\u0026rsquo;s execution environment. Specify each layer by its\u003cbr/\u003eARN, including the version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epackageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of deployment package. Set to Image for container image and set\u003cbr/\u003eto Zip for .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublish\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSet to true to publish the first version of the function during creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereservedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of simultaneous executions to reserve for the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the function\u0026rsquo;s execution role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruntime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the function\u0026rsquo;s runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).\u003cbr/\u003eRuntime is required if the deployment package is a .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html)\u003cbr/\u003esetting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.applyOn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)\u003cbr/\u003eto apply to the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of time (in seconds) that Lambda allows a function to run before\u003cbr/\u003estopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.\u003cbr/\u003eFor more information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSet Mode to Active to sample and trace a subset of incoming requests with\u003cbr/\u003eX-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor network connectivity to Amazon Web Services resources in a VPC, specify\u003cbr/\u003ea list of security groups and subnets in the VPC. When you connect a function\u003cbr/\u003eto a VPC, it can access resources and the internet only through that VPC.\u003cbr/\u003eFor more information, see Configuring a Lambda function to access resources\u003cbr/\u003ein a VPC (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcConfig.securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcConfig.securityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetIDs |\n| \u003cstrong\u003evpcConfig.subnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcConfig.subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcConfig.subnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncodeSHA256: string\ncodeSize: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nimageConfigResponse: \n error: \n errorCode: string\n message: string\n imageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nlastModified: string\nlastUpdateStatus: string\nlastUpdateStatusReason: string\nlastUpdateStatusReasonCode: string\nlayerStatuses:\n- arn: string\n codeSize: integer\n signingJobARN: string\n signingProfileVersionARN: string\nmasterARN: string\nrevisionID: string\nsigningJobARN: string\nsigningProfileVersionARN: string\nstate: string\nstateReason: string\nstateReasonCode: string\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSHA256\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SHA256 hash of the function\u0026rsquo;s deployment package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe size of the function\u0026rsquo;s deployment package, in bytes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s image configuration values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError response to GetFunctionConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration values that override the container image Dockerfile settings.\u003cbr/\u003eFor more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the function was last updated, in ISO-8601 format\u003cbr/\u003e(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the last update that was performed on the function. This is\u003cbr/\u003efirst set to Successful after function creation completes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].codeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].signingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].signingProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor Lambda@Edge functions, the ARN of the main function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe latest updated revision of the function or alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing profile version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the function. When the state is Inactive, you can reactivate\u003cbr/\u003ethe function by invoking it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the function\u0026rsquo;s current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the function\u0026rsquo;s current state. When the code is Creating,\u003cbr/\u003eyou can\u0026rsquo;t invoke or modify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:106,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/functionurlconfig/",title:"FunctionURLConfig",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#FunctionURLConfig"\u003elambda-controller/apis/v1alpha1#FunctionURLConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionURLConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionURLConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctionurlconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctionurlconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails about a Lambda function URL.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauthType: string\ncors: \n allowCredentials: boolean\n allowHeaders:\n - string\n allowMethods:\n - string\n allowOrigins:\n - string\n exposeHeaders:\n - string\n maxAge: integer\nfunctionName: string\nfunctionRef: \n from: \n name: string\nqualifier: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of authentication that your function URL uses. Set to AWS_IAM if\u003cbr/\u003eyou want to restrict access to authenticated IAM users only. Set to NONE\u003cbr/\u003eif you want to bypass IAM authentication to create a public endpoint. For\u003cbr/\u003emore information, see Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\u003cbr/\u003esettings for your function URL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equalifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe alias name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfunctionARN: string\nfunctionURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe HTTP URL endpoint for your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:107,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/globalcluster/",title:"GlobalCluster",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#GlobalCluster"\u003erds-controller/apis/v1alpha1#GlobalCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobalclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobalcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA data type representing an Aurora global database.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edatabaseName: string\ndeletionProtection: boolean\nengine: string\nengineVersion: string\nglobalClusterIdentifier: string\nsourceDBClusterIdentifier: string\nstorageEncrypted: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatabaseName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for your database of up to 64 alphanumeric characters. If you do\u003cbr/\u003enot provide a name, Amazon Aurora will not create a database in the global\u003cbr/\u003edatabase cluster you are creating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe deletion protection setting for the new global database. The global database\u003cbr/\u003ecan\u0026rsquo;t be deleted when deletion protection is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe engine version of the Aurora global database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier of the new global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceDBClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) to use as the primary cluster of the global\u003cbr/\u003edatabase. This parameter is optional.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe storage encryption setting for the new global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailoverState: \n fromDBClusterARN: string\n status: string\n toDBClusterARN: string\nglobalClusterMembers:\n- dbClusterARN: string\n globalWriteForwardingStatus: string\n isWriter: boolean\n readers:\n - string\nglobalClusterResourceID: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data object containing all properties for the current state of an in-process\u003cbr/\u003eor pending failover process for this Aurora global database. This object\u003cbr/\u003eis empty unless the FailoverGlobalCluster API operation has been called on\u003cbr/\u003ethis Aurora global database (GlobalCluster).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.fromDBClusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.toDBClusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of primary and secondary clusters within the global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data structure with information about any primary and secondary clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eassociated with an Aurora global database.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].globalWriteForwardingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].isWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].readers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].readers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:108,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/globaltable/",title:"GlobalTable",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#GlobalTable"\u003edynamodb-controller/apis/v1alpha1#GlobalTable\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobaltables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobaltable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the properties of a global table.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eglobalTableName: string\nreplicationGroup:\n- regionName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalTableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe global table name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroup\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Regions where the global table needs to be created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroup.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a replica.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDateTime: string\nglobalTableStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe creation time of the global table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalTableStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the global table:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The global table is being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - The global table is being updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The global table is being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The global table is ready for use.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:109,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/grant/",title:"Grant",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Grant"\u003ekms-controller/apis/v1alpha1#Grant\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGrant\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGrantList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egrants\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egrant\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econstraints: \n encryptionContextEquals: {}\n encryptionContextSubset: {}\ngrantTokens:\n- string\ngranteePrincipal: string\nkeyID: string\nkeyRef: \n from: \n name: string\nname: string\noperations:\n- string\nretiringPrincipal: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a grant constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS supports the EncryptionContextEquals and EncryptionContextSubset grant\u003cbr/\u003econstraints. Each constraint value can include up to 8 encryption context\u003cbr/\u003epairs. The encryption context value in each constraint cannot exceed 384\u003cbr/\u003echaracters. For information about grant constraints, see Using grant constraints\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints)\u003cbr/\u003ein the Key Management Service Developer Guide. For more information about\u003cbr/\u003eencryption context, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe encryption context grant constraints allow the permissions in the grant\u003cbr/\u003eonly when the encryption context in the request matches (EncryptionContextEquals)\u003cbr/\u003eor includes (EncryptionContextSubset) the encryption context specified in\u003cbr/\u003ethis structure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe encryption context grant constraints are supported only on grant operations\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)\u003cbr/\u003ethat include an EncryptionContext parameter, such as cryptographic operations\u003cbr/\u003eon symmetric encryption KMS keys. Grants with grant constraints can include\u003cbr/\u003ethe DescribeKey and RetireGrant operations, but the constraint doesn\u0026rsquo;t apply\u003cbr/\u003eto these operations. If a grant with a grant constraint includes the CreateGrant\u003cbr/\u003eoperation, the constraint requires that any grants created with the CreateGrant\u003cbr/\u003epermission have an equally strict or stricter encryption context constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use an encryption context grant constraint for cryptographic operations\u003cbr/\u003ewith asymmetric KMS keys or HMAC KMS keys. These keys don\u0026rsquo;t support an encryption\u003cbr/\u003econtext.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints.encryptionContextEquals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints.encryptionContextSubset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantTokens\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of grant tokens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a grant token when your permission to call this operation comes from\u003cbr/\u003ea new grant that has not yet achieved eventual consistency. For more information,\u003cbr/\u003esee Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)\u003cbr/\u003eand Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantTokens.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the KMS key for the grant. The grant gives principals permission\u003cbr/\u003eto use this KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the key ID or key ARN of the KMS key. To specify a KMS key in a different\u003cbr/\u003eAmazon Web Services account, you must use the key ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name for the grant. Use this value to prevent the unintended creation\u003cbr/\u003eof duplicate grants when retrying this request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen this value is absent, all CreateGrant requests result in a new grant\u003cbr/\u003ewith a unique GrantId even if all the supplied parameters are identical.\u003cbr/\u003eThis can result in unintended duplicates when you retry the CreateGrant request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen this value is present, you can retry a CreateGrant request with identical\u003cbr/\u003eparameters; if the grant already exists, the original GrantId is returned\u003cbr/\u003ewithout creating a new grant. Note that the returned grant token is unique\u003cbr/\u003ewith every CreateGrant request, even when a duplicate GrantId is returned.\u003cbr/\u003eAll grant tokens for the same grant ID can be used interchangeably.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperations\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of operations that the grant permits.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis list must include only operations that are permitted in a grant. Also,\u003cbr/\u003ethe operation must be supported on the KMS key. For example, you cannot create\u003cbr/\u003ea grant for a symmetric encryption KMS key that allows the Sign operation,\u003cbr/\u003eor a grant for an asymmetric KMS key that allows the GenerateDataKey operation.\u003cbr/\u003eIf you try, KMS returns a ValidationError exception. For details, see Grant\u003cbr/\u003eoperations (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ngrantID: string\ngrantToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the grant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe grant token.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a grant token when your permission to call this operation comes from\u003cbr/\u003ea new grant that has not yet achieved eventual consistency. For more information,\u003cbr/\u003esee Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)\u003cbr/\u003eand Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:110,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/group/",title:"Group",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Group"\u003eiam-controller/apis/v1alpha1#Group\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM group entity.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateGroup\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetGroup\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListGroups\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003einlinePolicies: {}\nname: string\npath: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the group to create. Do not include the path in this value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the group. For more information about paths, see IAM identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ngroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the group was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the group. For more information\u003cbr/\u003eabout IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:111,href:"https://aws-controllers-k8s.github.io/community/reference/route53/v1alpha1/hostedzone/",title:"HostedZone",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53-controller/apis/v1alpha1#HostedZone"\u003eroute53-controller/apis/v1alpha1#HostedZone\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHostedZone\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHostedZoneList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehostedzones\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehostedzone\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA complex type that contains general information about the hosted zone.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edelegationSetID: string\nhostedZoneConfig: \n comment: string\n privateZone: boolean\nname: string\ntags:\n- key: string\n value: string\nvpc: \n vpcID: string\n vpcRegion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edelegationSetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf you want to associate a reusable delegation set with this hosted zone,\u003cbr/\u003ethe ID that Amazon Route 53 assigned to the reusable delegation set when\u003cbr/\u003eyou created it. For more information about reusable delegation sets, see\u003cbr/\u003eCreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using a reusable delegation set to create a public hosted zone\u003cbr/\u003efor a subdomain, make sure that the parent hosted zone doesn\u0026rsquo;t use one or\u003cbr/\u003emore of the same name servers. If you have overlapping nameservers, the operation\u003cbr/\u003ewill cause a ConflictingDomainsExist error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Optional) A complex type that contains the following optional values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For public and private hosted zones, an optional comment\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For private hosted zones, an optional PrivateZone element\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify a comment or the PrivateZone element, omit HostedZoneConfig\u003cbr/\u003eand the other elements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig.privateZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the domain. Specify a fully qualified domain name, for example,\u003cbr/\u003ewww.example.com. The trailing dot is optional; Amazon Route 53 assumes that\u003cbr/\u003ethe domain name is fully qualified. This means that Route 53 treats www.example.com\u003cbr/\u003e(without a trailing dot) and www.example.com. (with a trailing dot) as identical.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating a public hosted zone, this is the name you have registered\u003cbr/\u003ewith your DNS registrar. If your domain name is registered with a registrar\u003cbr/\u003eother than Route 53, change the name servers for your domain to the set of\u003cbr/\u003eNameServers that CreateHostedZone returns in DelegationSet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a list of the tags that you want to add to the\u003cbr/\u003especified health check or hosted zone and/or the tags that you want to edit\u003cbr/\u003eValue for.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can add a maximum of 10 tags to a health check or a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about a tag that you want to add\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor edit for the specified health check or hosted zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Private hosted zones only) A complex type that contains information about\u003cbr/\u003ethe Amazon VPC that you\u0026rsquo;re associating with this hosted zone.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can specify only one Amazon VPC when you create a private hosted zone.\u003cbr/\u003eIf you are associating a VPC with a hosted zone with this request, the paramaters\u003cbr/\u003eVPCId and VPCRegion are also required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone\u003cbr/\u003e(https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html)\u003cbr/\u003eafter you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(Private hosted zones only) The ID of an Amazon VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.vpcRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncallerReference: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfig: \n comment: string\n privateZone: boolean\nid: string\nlinkedService: \n description: string\n servicePrincipal: string\nresourceRecordSetCount: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecallerReference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe value that you specified for CallerReference when you created the hosted\u003cbr/\u003ezone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that includes the Comment and PrivateZone elements. If you\u003cbr/\u003eomitted the HostedZoneConfig and Comment elements from the request, the Config\u003cbr/\u003eand Comment elements don\u0026rsquo;t appear in the response.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig.privateZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID that Amazon Route 53 assigned to the hosted zone when you created\u003cbr/\u003eit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIf the hosted zone was created by another service, the service that created\u003cbr/\u003ethe hosted zone. When a hosted zone is created by another service, you can\u0026rsquo;t\u003cbr/\u003eedit or delete it using Route 53.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService.servicePrincipal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceRecordSetCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of resource record sets in the hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:112,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/hyperparametertuningjob/",title:"HyperParameterTuningJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#HyperParameterTuningJob"\u003esagemaker-controller/apis/v1alpha1#HyperParameterTuningJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHyperParameterTuningJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHyperParameterTuningJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehyperparametertuningjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehyperparametertuningjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eautotune: \n mode: string\nhyperParameterTuningJobConfig: \n hyperParameterTuningJobObjective: \n metricName: string\n type_: string\n parameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n resourceLimits: \n maxNumberOfTrainingJobs: integer\n maxParallelTrainingJobs: integer\n strategy: string\n trainingJobEarlyStoppingType: string\n tuningJobCompletionCriteria: \n targetObjectiveMetricValue: number\nhyperParameterTuningJobName: string\ntags:\n- key: string\n value: string\ntrainingJobDefinition: \n algorithmSpecification: \n algorithmName: string\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\n checkpointConfig: \n localPath: string\n s3URI: string\n definitionName: string\n enableInterContainerTrafficEncryption: boolean\n enableManagedSpotTraining: boolean\n enableNetworkIsolation: boolean\n hyperParameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n inputDataConfig:\n - channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\n outputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\n resourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n retryStrategy: \n maximumRetryAttempts: integer\n roleARN: string\n staticHyperParameters: {}\n stoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\n tuningObjective: \n metricName: string\n type_: string\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\ntrainingJobDefinitions:\n algorithmSpecification: \n algorithmName: string\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\n checkpointConfig: \n localPath: string\n s3URI: string\n definitionName: string\n enableInterContainerTrafficEncryption: boolean\n enableManagedSpotTraining: boolean\n enableNetworkIsolation: boolean\n hyperParameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n inputDataConfig:\n - channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\n outputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\n resourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n retryStrategy: \n maximumRetryAttempts: integer\n roleARN: string\n staticHyperParameters: {}\n stoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\n tuningObjective: \n metricName: string\n type_: string\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nwarmStartConfig: \n parentHyperParameterTuningJobs:\n - hyperParameterTuningJobName: string\n warmStartType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautotune\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures SageMaker Automatic model tuning (AMT) to automatically find optimal\u003cbr/\u003eparameters for the following fields:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges):\u003cbr/\u003e The names and ranges of parameters that a hyperparameter tuning job can\u003cbr/\u003e optimize.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html):\u003cbr/\u003e The maximum resources that can be used for a training job. These resources\u003cbr/\u003e include the maximum number of training jobs, the maximum runtime of a\u003cbr/\u003e tuning job, and the maximum number of training jobs to run at the same\u003cbr/\u003e time.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TrainingJobEarlyStoppingType (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType):\u003cbr/\u003e A flag that specifies whether or not to use early stopping for training\u003cbr/\u003e jobs launched by a hyperparameter tuning job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RetryStrategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy):\u003cbr/\u003e The number of times to retry a training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Strategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html):\u003cbr/\u003e Specifies how hyperparameter tuning chooses the combinations of hyperparameter\u003cbr/\u003e values to use for the training jobs that it launches.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ConvergenceDetected (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html):\u003cbr/\u003e A flag to indicate that Automatic model tuning (AMT) has detected model\u003cbr/\u003e convergence.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautotune.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html)\u003cbr/\u003eobject that describes the tuning job, including the search strategy, the\u003cbr/\u003eobjective metric used to evaluate training jobs, ranges of parameters to\u003cbr/\u003esearch, and resource limits for the tuning job. For more information, see\u003cbr/\u003eHow Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.hyperParameterTuningJobObjective\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.hyperParameterTuningJobObjective.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**hyperParameterTuningJobConfig.hyperParameterTuningJobObjective.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eis eligible for Autotune, an optimal hyperparameter range is selected for\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters.[].valueHint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of categorical hyperparameters to tune.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[].values\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of continuous hyperparameters to tune.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etuning job searches.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the maximum number of training jobs and parallel training jobs\u003cbr/\u003ethat a hyperparameter tuning job can launch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits.maxNumberOfTrainingJobs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits.maxParallelTrainingJobs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.strategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe strategy hyperparameter tuning uses to find the best combination of hyperparameters\u003cbr/\u003efor your model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.trainingJobEarlyStoppingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.tuningJobCompletionCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe job completion criteria.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.tuningJobCompletionCriteria.targetObjectiveMetricValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the tuning job. This name is the prefix for the names of all\u003cbr/\u003etraining jobs that this tuning job launches. The name must be unique within\u003cbr/\u003ethe same Amazon Web Services account and Amazon Web Services Region. The\u003cbr/\u003ename must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and\u003cbr/\u003e: + = @ _ % - (hyphen). The name is not case sensitive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags that you specify for the tuning job are also added to all training jobs\u003cbr/\u003ethat the tuning job launches.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)\u003cbr/\u003eobject that describes the training jobs that this tuning job launches, including\u003cbr/\u003estatic hyperparameters, input data configuration, output data configuration,\u003cbr/\u003eresource configuration, and stopping condition. |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies which training algorithm to use for training jobs that a hyperparameter\u003cbr/\u003etuning job launches and the metrics to monitor. |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.algorithmName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\nYou can view these logs to understand how your training job performs and\ncheck for any errors encountered during training. SageMaker hyperparameter\ntuning captures all defined metrics. Specify one of the defined metrics to\nuse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\nparameter in the HyperParameterTrainingJobDefinition API to evaluate job\nperformance during hyperparameter tuning. || \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[].regex\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.trainingImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.trainingInputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data. |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.definitionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableManagedSpotTraining\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified. |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\nin Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\nis eligible for Autotune, an optimal hyperparameter range is selected for\nyou. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[].valueHint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of categorical hyperparameters to tune. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].values\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of continuous hyperparameters to tune. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].maxValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\ntuning job searches. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].maxValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA channel is a named input source that training algorithms can consume. || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].channelName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a file system data source for a channel. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.directoryPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.attributeNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.attributeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].inputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].recordWrapperType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].shuffleConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].shuffleConfig.seed\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides information about how to store model training results (model artifacts). |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including machine learning (ML) compute instances\u003cbr/\u003eand ML storage volumes, to use for model training. |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\na training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\nAPI, you can configure multiple instance groups . || \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.keepAlivePeriodInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished. |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.retryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe retry strategy to use when a training job fails due to an InternalServerError.\u003cbr/\u003eRetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob\u003cbr/\u003erequests. You can add the StoppingCondition parameter to the request to limit\u003cbr/\u003ethe training time for the complete job. |\n| \u003cstrong\u003etrainingJobDefinition.retryStrategy.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.staticHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a limit to how long a model training job or model compilation job\u003cbr/\u003ecan run. It also specifies how long a managed spot training job has to complete.\u003cbr/\u003eWhen the job reaches the time limit, SageMaker ends the training or compilation\u003cbr/\u003ejob. Use this API to cap model training costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\u003cbr/\u003ewhich delays job termination for 120 seconds. Algorithms can use this 120-second\u003cbr/\u003ewindow to save the model artifacts, so the results of training are not lost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe training algorithms provided by SageMaker automatically save the intermediate\u003cbr/\u003eresults of a model training job when possible. This attempt to save artifacts\u003cbr/\u003eis only a best effort case as model might not be in a state from which it\u003cbr/\u003ecan be saved. For example, if training has just started, the model might\u003cbr/\u003enot be ready to save. When saved, this intermediate data is a valid model\u003cbr/\u003eartifact. You can use it to create a model with CreateModel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Neural Topic Model (NTM) currently does not support saving intermediate\u003cbr/\u003emodel artifacts. When training NTMs, make sure that the maximum runtime is\u003cbr/\u003esufficient for the training job to complete. |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxPendingTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eMaximum job scheduler pending time in seconds. |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxWaitTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.tuningObjective\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). |\n| \u003cstrong\u003etrainingJobDefinition.tuningObjective.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **trainingJobDefinition.tuningObjective.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| **trainingJobDefinition.vpcConfig.securityGroupIDs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig.securityGroupIDs.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinition.vpcConfig.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)\u003cbr/\u003eobjects launched for this tuning job. |\n| **trainingJobDefinitions.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDefines the training jobs launched by a hyperparameter tuning job. || **trainingJobDefinitions.[].algorithmSpecification**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies which training algorithm to use for training jobs that a hyperparameter\u003cbr/\u003etuning job launches and the metrics to monitor. |\n| **trainingJobDefinitions.[].algorithmSpecification.algorithmName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\nYou can view these logs to understand how your training job performs and\ncheck for any errors encountered during training. SageMaker hyperparameter\ntuning captures all defined metrics. Specify one of the defined metrics to\nuse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\nparameter in the HyperParameterTrainingJobDefinition API to evaluate job\nperformance during hyperparameter tuning. || **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[].regex**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.trainingImage**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.trainingInputMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| **trainingJobDefinitions.[].checkpointConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data. |\n| **trainingJobDefinitions.[].checkpointConfig.localPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].checkpointConfig.s3URI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].definitionName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableInterContainerTrafficEncryption**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableManagedSpotTraining**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableNetworkIsolation**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified. |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\nin Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\nis eligible for Autotune, an optimal hyperparameter range is selected for\nyou. || **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[].valueHint**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of categorical hyperparameters to tune. || **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].values**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].values.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of continuous hyperparameters to tune. || **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].maxValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].minValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].scalingType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\ntuning job searches. || **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].maxValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].minValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].scalingType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA channel is a named input source that training algorithms can consume. || **trainingJobDefinitions.[].inputDataConfig.[].channelName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].compressionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].contentType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the location of the channel data. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a file system data source for a channel. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.directoryPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.attributeNames**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.attributeNames.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3DataDistributionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3DataType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3URI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].inputMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| **trainingJobDefinitions.[].inputDataConfig.[].recordWrapperType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].shuffleConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch. |\n| **trainingJobDefinitions.[].inputDataConfig.[].shuffleConfig.seed**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eProvides information about how to store model training results (model artifacts). |\n| **trainingJobDefinitions.[].outputDataConfig.compressionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig.kmsKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig.s3OutputPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the resources, including machine learning (ML) compute instances\u003cbr/\u003eand ML storage volumes, to use for model training. |\n| **trainingJobDefinitions.[].resourceConfig.instanceCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\na training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\nAPI, you can configure multiple instance groups . || **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceGroupName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.keepAlivePeriodInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished. |\n| **trainingJobDefinitions.[].resourceConfig.volumeKMSKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.volumeSizeInGB**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].retryStrategy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe retry strategy to use when a training job fails due to an InternalServerError.\u003cbr/\u003eRetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob\u003cbr/\u003erequests. You can add the StoppingCondition parameter to the request to limit\u003cbr/\u003ethe training time for the complete job. |\n| **trainingJobDefinitions.[].retryStrategy.maximumRetryAttempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].roleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].staticHyperParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].stoppingCondition**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a limit to how long a model training job or model compilation job\u003cbr/\u003ecan run. It also specifies how long a managed spot training job has to complete.\u003cbr/\u003eWhen the job reaches the time limit, SageMaker ends the training or compilation\u003cbr/\u003ejob. Use this API to cap model training costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\u003cbr/\u003ewhich delays job termination for 120 seconds. Algorithms can use this 120-second\u003cbr/\u003ewindow to save the model artifacts, so the results of training are not lost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe training algorithms provided by SageMaker automatically save the intermediate\u003cbr/\u003eresults of a model training job when possible. This attempt to save artifacts\u003cbr/\u003eis only a best effort case as model might not be in a state from which it\u003cbr/\u003ecan be saved. For example, if training has just started, the model might\u003cbr/\u003enot be ready to save. When saved, this intermediate data is a valid model\u003cbr/\u003eartifact. You can use it to create a model with CreateModel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Neural Topic Model (NTM) currently does not support saving intermediate\u003cbr/\u003emodel artifacts. When training NTMs, make sure that the maximum runtime is\u003cbr/\u003esufficient for the training job to complete. |\n| **trainingJobDefinitions.[].stoppingCondition.maxPendingTimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003eMaximum job scheduler pending time in seconds. |\n| **trainingJobDefinitions.[].stoppingCondition.maxRuntimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].stoppingCondition.maxWaitTimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].tuningObjective**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). |\n| **trainingJobDefinitions.[].tuningObjective.metricName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].tuningObjective.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| **trainingJobDefinitions.[].vpcConfig.securityGroupIDs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig.securityGroupIDs.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].vpcConfig.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **warmStartConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies the configuration for starting the hyperparameter tuning job using\u003cbr/\u003eone or more previous tuning jobs as a starting point. The results of previous\u003cbr/\u003etuning jobs are used to inform which combinations of hyperparameters to search\u003cbr/\u003eover in the new tuning job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll training jobs launched by the new hyperparameter tuning job are evaluated\u003cbr/\u003eby using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM\u003cbr/\u003eas the WarmStartType value for the warm start configuration, the training\u003cbr/\u003ejob that performs the best in the new tuning job is compared to the best\u003cbr/\u003etraining jobs from the parent tuning jobs. From these, the training job that\u003cbr/\u003eperforms the best as measured by the objective metric is returned as the\u003cbr/\u003eoverall best training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll training jobs launched by parent hyperparameter tuning jobs and the new\u003cbr/\u003ehyperparameter tuning jobs count against the limit of training jobs for the\u003cbr/\u003etuning job. |\n| **warmStartConfig.parentHyperParameterTuningJobs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **warmStartConfig.parentHyperParameterTuningJobs.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA previously completed or stopped hyperparameter tuning job to be used as\na starting point for a new hyperparameter tuning job. || **warmStartConfig.parentHyperParameterTuningJobs.[].hyperParameterTuningJobName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **warmStartConfig.warmStartType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbestTrainingJob: \n creationTime: string\n failureReason: string\n finalHyperParameterTuningJobObjectiveMetric: \n metricName: string\n type_: string\n value: number\n objectiveStatus: string\n trainingEndTime: string\n trainingJobARN: string\n trainingJobDefinitionName: string\n trainingJobName: string\n trainingJobStatus: string\n trainingStartTime: string\n tunedHyperParameters: {}\n tuningJobName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nhyperParameterTuningJobStatus: string\noverallBestTrainingJob: \n creationTime: string\n failureReason: string\n finalHyperParameterTuningJobObjectiveMetric: \n metricName: string\n type_: string\n value: number\n objectiveStatus: string\n trainingEndTime: string\n trainingJobARN: string\n trainingJobDefinitionName: string\n trainingJobName: string\n trainingJobStatus: string\n trainingStartTime: string\n tunedHyperParameters: {}\n tuningJobName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)\u003cbr/\u003eobject that describes the training job that completed with the best current\u003cbr/\u003eHyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eShows the latest objective metric emitted by a training job that was launched\u003cbr/\u003eby a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective\u003cbr/\u003eparameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.objectiveStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.tunedHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.tuningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the tuning job failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the tuning job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIf the hyperparameter tuning job is an warm start tuning job with a WarmStartType\u003cbr/\u003eof IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)\u003cbr/\u003efor the training job with the best objective metric value of all training\u003cbr/\u003ejobs launched by this tuning job and all parent jobs specified for the warm\u003cbr/\u003estart tuning job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eShows the latest objective metric emitted by a training job that was launched\u003cbr/\u003eby a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective\u003cbr/\u003eparameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.objectiveStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.tunedHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.tuningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:113,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/instance/",title:"Instance",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#Instance"\u003eec2-controller/apis/v1alpha1#Instance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes an instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eblockDeviceMappings:\n- deviceName: string\n ebs: \n deleteOnTermination: boolean\n encrypted: boolean\n iops: integer\n kmsKeyID: string\n outpostARN: string\n snapshotID: string\n throughput: integer\n volumeSize: integer\n volumeType: string\n noDevice: string\n virtualName: string\ncapacityReservationSpecification: \n capacityReservationPreference: string\n capacityReservationTarget: \n capacityReservationID: string\n capacityReservationResourceGroupARN: string\ncpuOptions: \n coreCount: integer\n threadsPerCore: integer\ncreditSpecification: \n cpuCredits: string\ndisableAPIStop: boolean\ndisableAPITermination: boolean\nebsOptimized: boolean\nelasticGPUSpecification:\n- type_: string\nelasticInferenceAccelerators:\n- count: integer\n type_: string\nenclaveOptions: \n enabled: boolean\nhibernationOptions: \n configured: boolean\niamInstanceProfile: \n arn: string\n name: string\nimageID: string\ninstanceInitiatedShutdownBehavior: string\ninstanceMarketOptions: \n marketType: string\n spotOptions: \n blockDurationMinutes: integer\n instanceInterruptionBehavior: string\n maxPrice: string\n spotInstanceType: string\n validUntil: string\ninstanceType: string\nipv6AddressCount: integer\nipv6Addresses:\n- ipv6Address: string\nkernelID: string\nkeyName: string\nlaunchTemplate: \n launchTemplateID: string\n launchTemplateName: string\n version: string\nlicenseSpecifications:\n- licenseConfigurationARN: string\nmaintenanceOptions: \n autoRecovery: string\nmaxCount: integer\nmetadataOptions: \n httpEndpoint: string\n httpProtocolIPv6: string\n httpPutResponseHopLimit: integer\n httpTokens: string\n instanceMetadataTags: string\nminCount: integer\nmonitoring: \n enabled: boolean\nnetworkInterfaces:\n- associateCarrierIPAddress: boolean\n associatePublicIPAddress: boolean\n deleteOnTermination: boolean\n description: string\n deviceIndex: integer\n interfaceType: string\n ipv4PrefixCount: integer\n ipv4Prefixes:\n - ipv4Prefix: string\n ipv6AddressCount: integer\n ipv6Addresses:\n - ipv6Address: string\n ipv6PrefixCount: integer\n ipv6Prefixes:\n - ipv6Prefix: string\n networkCardIndex: integer\n networkInterfaceID: string\n privateIPAddress: string\n privateIPAddresses:\n - primary: boolean\n privateIPAddress: string\n secondaryPrivateIPAddressCount: integer\n subnetID: string\nplacement: \n affinity: string\n availabilityZone: string\n groupName: string\n hostID: string\n hostResourceGroupARN: string\n partitionNumber: integer\n spreadDomain: string\n tenancy: string\nprivateDNSNameOptions: \n enableResourceNameDNSAAAARecord: boolean\n enableResourceNameDNSARecord: boolean\n hostnameType: string\nprivateIPAddress: string\nramDiskID: string\nsecurityGroupIDs:\n- string\nsecurityGroups:\n- string\nsubnetID: string\ntags:\n- key: string\n value: string\nuserData: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe block device mapping, which defines the EBS volumes and instance store\u003cbr/\u003evolumes to attach to the instance at launch. For more information, see Block\u003cbr/\u003edevice mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a block device mapping, which defines the EBS volumes and instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003estore volumes to attach to an instance at launch.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a block device for an EBS volume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.deleteOnTermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.outpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.throughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].noDevice\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].virtualName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the Capacity Reservation targeting option. If you do not\u003cbr/\u003especify this parameter, the instance\u0026rsquo;s Capacity Reservation preference defaults\u003cbr/\u003eto open, which enables it to run in any open Capacity Reservation that has\u003cbr/\u003ematching attributes (instance type, platform, Availability Zone).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationPreference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a target Capacity Reservation or Capacity Reservation group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget.capacityReservationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget.capacityReservationResourceGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe CPU options for the instance. For more information, see Optimize CPU\u003cbr/\u003eoptions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions.coreCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions.threadsPerCore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreditSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe credit option for CPU usage of the burstable performance instance. Valid\u003cbr/\u003evalues are standard and unlimited. To change this attribute after launch,\u003cbr/\u003euse ModifyInstanceCreditSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html).\u003cbr/\u003eFor more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: standard (T2 instances) or unlimited (T3/T3a/T4g instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor T3 instances with host tenancy, only standard is supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreditSpecification.cpuCredits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableAPIStop\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance is enabled for stop protection. For more information,\u003cbr/\u003esee Stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableAPITermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you set this parameter to true, you can\u0026rsquo;t terminate the instance using\u003cbr/\u003ethe Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute\u003cbr/\u003eafter launch, use ModifyInstanceAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html).\u003cbr/\u003eAlternatively, if you set InstanceInitiatedShutdownBehavior to terminate,\u003cbr/\u003eyou can terminate the instance by running the shutdown command from the instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptimized\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the instance is optimized for Amazon EBS I/O. This optimization\u003cbr/\u003eprovides dedicated throughput to Amazon EBS and an optimized configuration\u003cbr/\u003estack to provide optimal Amazon EBS I/O performance. This optimization isn\u0026rsquo;t\u003cbr/\u003eavailable with all instance types. Additional usage charges apply when using\u003cbr/\u003ean EBS-optimized instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn elastic GPU to associate with the instance. An Elastic GPU is a GPU resource\u003cbr/\u003ethat you can attach to your Windows instance to accelerate the graphics performance\u003cbr/\u003eof your applications. For more information, see Amazon EC2 Elastic GPUs (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUSpecification.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA specification for an Elastic Graphics accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAccelerators\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn elastic inference accelerator to associate with the instance. Elastic\u003cbr/\u003einference accelerators are a resource you can attach to your Amazon EC2 instances\u003cbr/\u003eto accelerate your Deep Learning (DL) inference workloads.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify accelerators from different generations in the same request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAccelerators.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an elastic inference accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**elasticInferenceAccelerators.[].type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenclaveOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\u003cbr/\u003eFor more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html)\u003cbr/\u003ein the Amazon Web Services Nitro Enclaves User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t enable Amazon Web Services Nitro Enclaves and hibernation on the\u003cbr/\u003esame instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenclaveOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehibernationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance is enabled for hibernation. For more information,\u003cbr/\u003esee Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t enable hibernation and Amazon Web Services Nitro Enclaves on the\u003cbr/\u003esame instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehibernationOptions.configured\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of an IAM instance profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the AMI. An AMI ID is required to launch an instance and must be\u003cbr/\u003especified here or in a launch template.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceInitiatedShutdownBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance stops or terminates when you initiate shutdown\u003cbr/\u003efrom the instance (using the operating system command for system shutdown).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: stop\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe market (purchasing) option for the instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RunInstances, persistent Spot Instance requests are only supported when\u003cbr/\u003eInstanceInterruptionBehavior is set to either hibernate or stop.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.marketType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe options for Spot Instances.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.blockDurationMinutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.instanceInterruptionBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.maxPrice\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.spotInstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.validUntil\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: m1.small\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6AddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The number of IPv6 addresses to associate with the primary network\u003cbr/\u003einterface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.\u003cbr/\u003eYou cannot specify this option and the option to assign specific IPv6 addresses\u003cbr/\u003ein the same request. You can specify this option if you\u0026rsquo;ve specified a minimum\u003cbr/\u003enumber of instances to launch.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Addresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with\u003cbr/\u003ethe primary network interface. You cannot specify this option and the option\u003cbr/\u003eto assign a number of IPv6 addresses in the same request. You cannot specify\u003cbr/\u003ethis option if you\u0026rsquo;ve specified a minimum number of instances to launch.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Addresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekernelID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the kernel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\u003cbr/\u003einformation, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the key pair. You can create a key pair using CreateKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html)\u003cbr/\u003eor ImportKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a key pair, you can\u0026rsquo;t connect to the instance unless\u003cbr/\u003eyou choose an AMI that is configured to allow users another way to log in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe launch template to use to launch the instances. Any parameters that you\u003cbr/\u003especify in RunInstances override the same parameters in the launch template.\u003cbr/\u003eYou can specify either the name or ID of a launch template, but not both.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.launchTemplateID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.launchTemplateName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.version\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe license configurations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a license configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe maintenance and recovery options for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceOptions.autoRecovery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of instances to launch. If you specify more instances\u003cbr/\u003ethan Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches\u003cbr/\u003ethe largest possible number of instances above MinCount.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Between 1 and the maximum number you\u0026rsquo;re allowed for the specified\u003cbr/\u003einstance type. For more information about the default limits, and how to\u003cbr/\u003erequest an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2)\u003cbr/\u003ein the Amazon EC2 FAQ.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata options for the instance. For more information, see Instance\u003cbr/\u003emetadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpProtocolIPv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpPutResponseHopLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpTokens\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.instanceMetadataTags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe minimum number of instances to launch. If you specify a minimum that\u003cbr/\u003eis more instances than Amazon EC2 can launch in the target Availability Zone,\u003cbr/\u003eAmazon EC2 launches no instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Between 1 and the maximum number you\u0026rsquo;re allowed for the specified\u003cbr/\u003einstance type. For more information about the default limits, and how to\u003cbr/\u003erequest an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2)\u003cbr/\u003ein the Amazon EC2 General FAQ.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether detailed monitoring is enabled for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoring.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe network interfaces to associate with the instance. If you specify a network\u003cbr/\u003einterface, you must specify any security groups and subnets as part of the\u003cbr/\u003enetwork interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].associatePublicIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].deleteOnTermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].deviceIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].interfaceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4PrefixCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4Prefixes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4Prefixes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IPv4 prefix option for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6AddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Addresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Addresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6PrefixCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Prefixes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Prefixes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IPv4 prefix option for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].networkCardIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a secondary private IPv4 address for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses.[].privateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].secondaryPrivateIPAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe placement for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.affinity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.availabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.hostID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.hostResourceGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.partitionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.spreadDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.tenancy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe options for the instance hostname. The default values are inherited from\u003cbr/\u003ethe subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.enableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.enableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.hostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4\u003cbr/\u003eaddress range of the subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnly one private IP address can be designated as primary. You can\u0026rsquo;t specify\u003cbr/\u003ethis option if you\u0026rsquo;ve specified the option to designate a private IP address\u003cbr/\u003eas the primary IP address in a network interface specification. You cannot\u003cbr/\u003especify this option if you\u0026rsquo;re launching more than one instance in the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eramDiskID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the RAM disk to select. Some kernels require additional drivers\u003cbr/\u003eat launch. Check the kernel requirements for information about whether you\u003cbr/\u003eneed to specify a RAM disk. To find kernel requirements, go to the Amazon\u003cbr/\u003eWeb Services Resource Center and search for the kernel ID.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\u003cbr/\u003einformation, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IDs of the security groups. You can create a security group using CreateSecurityGroup\u003cbr/\u003e(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a network interface, you must specify any security groups\u003cbr/\u003eas part of the network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe user data script to make available to the instance. For more information,\u003cbr/\u003esee Run commands on your Linux instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html)\u003cbr/\u003eand Run commands on your Windows instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html).\u003cbr/\u003eIf you are using a command line tool, base64-encoding is performed for you,\u003cbr/\u003eand you can load the text from a file. Otherwise, you must provide base64-encoded\u003cbr/\u003etext. User data is limited to 16 KB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\namiLaunchIndex: integer\narchitecture: string\nbootMode: string\ncapacityReservationID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nelasticGPUAssociations:\n- elasticGPUAssociationID: string\n elasticGPUAssociationState: string\n elasticGPUAssociationTime: string\n elasticGPUID: string\nelasticInferenceAcceleratorAssociations:\n- elasticInferenceAcceleratorARN: string\n elasticInferenceAcceleratorAssociationID: string\n elasticInferenceAcceleratorAssociationState: string\n elasticInferenceAcceleratorAssociationTime: string\nenaSupport: boolean\nhypervisor: string\ninstanceID: string\ninstanceLifecycle: string\nipv6Address: string\nlaunchTime: string\nlicenses:\n- licenseConfigurationARN: string\noutpostARN: string\nplatform: string\nplatformDetails: string\nprivateDNSName: string\nproductCodes:\n- productCodeID: string\n productCodeType: string\npublicDNSName: string\npublicIPAddress: string\nrootDeviceName: string\nrootDeviceType: string\nsourceDestCheck: boolean\nspotInstanceRequestID: string\nsriovNetSupport: string\nstate: \n code: integer\n name: string\nstateReason: \n code: string\n message: string\nstateTransitionReason: string\ntpmSupport: string\nusageOperation: string\nusageOperationUpdateTime: string\nvirtualizationType: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamiLaunchIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe AMI launch index, which can be used to find this instance in the launch\u003cbr/\u003egroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitecture\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe architecture of the image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebootMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe boot mode of the instance. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Capacity Reservation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Elastic GPU associated with the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the association between an instance and an Elastic Graphics accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUAssociationState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUAssociationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe elastic inference accelerator associated with the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the association between an instance and an elastic inference accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenaSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehypervisor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe hypervisor type of the instance. The value xen is used for both Xen and\u003cbr/\u003eNitro hypervisors.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceLifecycle\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is a Spot Instance or a Scheduled Instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 address assigned to the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time the instance was launched.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe license configurations for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a license configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatform\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe value is Windows for Windows instances; otherwise blank.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform details value for the instance. For more information, see AMI\u003cbr/\u003ebilling information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(IPv4 only) The private DNS hostname name assigned to the instance. This\u003cbr/\u003eDNS hostname can only be used inside the Amazon EC2 network. This name is\u003cbr/\u003enot available until the instance enters the running state.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private\u003cbr/\u003eDNS hostnames if you\u0026rsquo;ve enabled DNS resolution and DNS hostnames in your\u003cbr/\u003eVPC. If you are not using the Amazon-provided DNS server in your VPC, your\u003cbr/\u003ecustom domain name servers must resolve the hostname as appropriate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe product codes attached to this instance, if applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a product code.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes.[].productCodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicDNSName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(IPv4 only) The public DNS name assigned to the instance. This name is not\u003cbr/\u003eavailable until the instance enters the running state. For EC2-VPC, this\u003cbr/\u003ename is only available if you\u0026rsquo;ve enabled DNS hostnames for your VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe public IPv4 address, or the Carrier IP address assigned to the instance,\u003cbr/\u003eif applicable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA Carrier IP address only applies to an instance launched in a subnet associated\u003cbr/\u003ewith a Wavelength Zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDeviceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe device name of the root device volume (for example, /dev/sda1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDeviceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe root device type used by the AMI. The AMI can use an EBS volume or an\u003cbr/\u003einstance store volume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceDestCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether source/destination checking is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003espotInstanceRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the request is a Spot Instance request, the ID of the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esriovNetSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function\u003cbr/\u003einterface is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe current state of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe reason for the most recent state transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateTransitionReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the most recent state transition. This might be an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etpmSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the instance is configured for NitroTPM support, the value is v2.0. For\u003cbr/\u003emore information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageOperation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe usage operation value for the instance. For more information, see AMI\u003cbr/\u003ebilling information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageOperationUpdateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that the usage operation was last updated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualizationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtualization type of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The ID of the VPC in which the instance is running.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:114,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/instanceprofile/",title:"InstanceProfile",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#InstanceProfile"\u003eiam-controller/apis/v1alpha1#InstanceProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstanceprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstanceprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an instance profile.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateInstanceProfile\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetInstanceProfile\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListInstanceProfiles\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListInstanceProfilesForRole\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\npath: string\nrole: string\nroleRef: \n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the instance profile to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of upper and lowercase alphanumeric characters\u003cbr/\u003ewith no spaces. You can also include any of the following characters: _+=,.@-\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the instance profile. For more information about paths, see IAM\u003cbr/\u003eIdentifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the newly created IAM instance\u003cbr/\u003eprofile. Each tag consists of a key name and an associated value. For more\u003cbr/\u003einformation about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ninstanceProfileID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date when the instance profile was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceProfileID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the instance profile. For more information\u003cbr/\u003eabout IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:115,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/integration/",title:"Integration",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Integration"\u003eapigatewayv2-controller/apis/v1alpha1#Integration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eIntegration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eIntegrationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eintegrations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eintegration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an integration.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\nconnectionID: string\nconnectionRef: \n from: \n name: string\nconnectionType: string\ncontentHandlingStrategy: string\ncredentialsARN: string\ndescription: string\nintegrationMethod: string\nintegrationSubtype: string\nintegrationType: string\nintegrationURI: string\npassthroughBehavior: string\npayloadFormatVersion: string\nrequestParameters: {}\nrequestTemplates: {}\nresponseParameters: {}\ntemplateSelectionExpression: string\ntimeoutInMillis: integer\ntlsConfig: \n serverNameToVerify: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentHandlingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationMethod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationSubtype\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epassthroughBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epayloadFormatVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestTemplates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etemplateSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeoutInMillis\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TLS configuration for a private integration. If you specify a TLS configuration,\u003cbr/\u003eprivate integration traffic uses the HTTPS protocol. Supported only for HTTP\u003cbr/\u003eAPIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsConfig.serverNameToVerify\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string with a length between [1-512].\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nintegrationID: string\nintegrationResponseSelectionExpression: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationResponseSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:116,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/internetgateway/",title:"InternetGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#InternetGateway"\u003eec2-controller/apis/v1alpha1#InternetGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInternetGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInternetGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einternetgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einternetgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes an internet gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003erouteTableRefs:\n from: \n name: string\nrouteTables:\n- string\ntags:\n- key: string\n value: string\nvpc: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nattachments:\n- state: string\n vpcID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ninternetGatewayID: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAny VPCs attached to the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the attachment of a VPC to an internet gateway or an egress-only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einternet gateway.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:117,href:"https://aws-controllers-k8s.github.io/community/reference/emrcontainers/v1alpha1/jobrun/",title:"JobRun",description:null,content:'\u003cp\u003e\u003ccode\u003eemrcontainers.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/emrcontainers-controller/apis/v1alpha1#JobRun"\u003eemrcontainers-controller/apis/v1alpha1#JobRun\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eJobRun\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eJobRunList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ejobruns\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ejobrun\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis entity describes a job run. A job run is a unit of work, such as a Spark\njar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on\nEKS.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfigurationOverrides: string\nexecutionRoleARN: string\njobDriver: \n sparkSubmitJobDriver: \n entryPoint: string\n entryPointArguments:\n - string\n sparkSubmitParameters: string\nname: string\nreleaseLabel: string\ntags: {}\nvirtualClusterID: string\nvirtualClusterRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe execution role ARN for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe job driver for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about job driver for Spark submit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPointArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPointArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereleaseLabel\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon EMR release version to use for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tags assigned to job runs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtual cluster ID for which the job run request is submitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nstate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis output displays the started job run ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:118,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/key/",title:"Key",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Key"\u003ekms-controller/apis/v1alpha1#Key\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKey\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeys\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekey\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebypassPolicyLockoutSafetyCheck: boolean\ncustomKeyStoreID: string\ndescription: string\nenableKeyRotation: boolean\nkeySpec: string\nkeyUsage: string\nmultiRegion: boolean\norigin: string\npolicy: string\ntags:\n- tagKey: string\n tagValue: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebypassPolicyLockoutSafetyCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag to indicate whether to bypass the key policy lockout safety check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSetting this value to true increases the risk that the KMS key becomes unmanageable.\u003cbr/\u003eDo not set this value to true indiscriminately.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, refer to the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)\u003cbr/\u003esection in the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse this parameter only when you include a policy in the request and you\u003cbr/\u003eintend to prevent the principal that is making the request from making a\u003cbr/\u003esubsequent PutKeyPolicy request on the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomKeyStoreID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eCreates the KMS key in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003eand the key material in its associated CloudHSM cluster. To create a KMS\u003cbr/\u003ekey in a custom key store, you must also specify the Origin parameter with\u003cbr/\u003ea value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the\u003cbr/\u003ecustom key store must have at least two active HSMs, each in a different\u003cbr/\u003eAvailability Zone in the Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is valid only for symmetric encryption KMS keys in a single\u003cbr/\u003eRegion. You cannot create any other type of KMS key in a custom key store.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo find the ID of a custom key store, use the DescribeCustomKeyStores operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe response includes the custom key store ID and the ID of the CloudHSM\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis operation is part of the custom key store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003efeature in KMS, which combines the convenience and extensive integration\u003cbr/\u003eof KMS with the isolation and control of a single-tenant key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a description that helps you decide whether the KMS key is appropriate\u003cbr/\u003efor a task. The default value is an empty string (no description).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo set or change the description after the key is created, use UpdateKeyDescription.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableKeyRotation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeySpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT,\u003cbr/\u003ecreates a KMS key with a 256-bit AES-GCM key that is used for encryption\u003cbr/\u003eand decryption, except in China Regions, where it creates a 128-bit symmetric\u003cbr/\u003ekey that uses SM4 encryption. For help choosing a key spec for your KMS key,\u003cbr/\u003esee Choosing a KMS key type (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KeySpec determines whether the KMS key contains a symmetric key or an\u003cbr/\u003easymmetric key pair. It also determines the cryptographic algorithms that\u003cbr/\u003ethe KMS key supports. You can\u0026rsquo;t change the KeySpec after the KMS key is created.\u003cbr/\u003eTo further restrict the algorithms that can be used with the KMS key, use\u003cbr/\u003ea condition key in its key policy or IAM policy. For more information, see\u003cbr/\u003ekms:EncryptionAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm),\u003cbr/\u003ekms:MacAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm)\u003cbr/\u003eor kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Web Services services that are integrated with KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration)\u003cbr/\u003euse symmetric encryption KMS keys to protect your data. These services do\u003cbr/\u003enot support asymmetric KMS keys or HMAC KMS keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS supports the following key specs for KMS keys:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Symmetric encryption key (default) SYMMETRIC_DEFAULT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384 HMAC_512\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1)\u003cbr/\u003e ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1),\u003cbr/\u003e commonly used for cryptocurrencies.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SM2 key pairs (China Regions only) SM2\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDetermines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)\u003cbr/\u003efor which you can use the KMS key. The default value is ENCRYPT_DECRYPT.\u003cbr/\u003eThis parameter is optional when you are creating a symmetric encryption KMS\u003cbr/\u003ekey; otherwise, it is required. You can\u0026rsquo;t change the KeyUsage value after\u003cbr/\u003ethe KMS key is created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSelect only one valid value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT\u003cbr/\u003e or SIGN_VERIFY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with SM2 key material (China Regions only),\u003cbr/\u003e specify ENCRYPT_DECRYPT or SIGN_VERIFY.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eCreates a multi-Region primary key that you can replicate into other Amazon\u003cbr/\u003eWeb Services Regions. You cannot change this value after you create the KMS\u003cbr/\u003ekey.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a multi-Region key, set this parameter to True. For a single-Region KMS\u003cbr/\u003ekey, omit this parameter or set it to False. The default value is False.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis operation supports multi-Region keys, an KMS feature that lets you create\u003cbr/\u003emultiple interoperable KMS keys in different Amazon Web Services Regions.\u003cbr/\u003eBecause these KMS keys have the same key ID, key material, and other metadata,\u003cbr/\u003eyou can use them interchangeably to encrypt data in one Amazon Web Services\u003cbr/\u003eRegion and decrypt it in a different Amazon Web Services Region without re-encrypting\u003cbr/\u003ethe data or making a cross-Region call. For more information about multi-Region\u003cbr/\u003ekeys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value creates a primary key, not a replica. To create a replica key,\u003cbr/\u003euse the ReplicateKey operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create a multi-Region version of a symmetric encryption KMS key,\u003cbr/\u003ean HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material.\u003cbr/\u003eHowever, you cannot create a multi-Region key in a custom key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eorigin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe source of the key material for the KMS key. You cannot change the origin\u003cbr/\u003eafter you create the KMS key. The default is AWS_KMS, which means that KMS\u003cbr/\u003ecreates the key material.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a KMS key with no key material (for imported key material), set\u003cbr/\u003ethe value to EXTERNAL. For more information about importing key material\u003cbr/\u003einto KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)\u003cbr/\u003ein the Key Management Service Developer Guide. This value is valid only for\u003cbr/\u003esymmetric encryption KMS keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a KMS key in an KMS custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003eand create its key material in the associated CloudHSM cluster, set this\u003cbr/\u003evalue to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to\u003cbr/\u003eidentify the custom key store. This value is valid only for symmetric encryption\u003cbr/\u003eKMS keys.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe key policy to attach to the KMS key. If you do not specify a key policy,\u003cbr/\u003eKMS attaches a default key policy to the KMS key. For more information, see\u003cbr/\u003eDefault key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you provide a key policy, it must meet the following criteria:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you don\u0026rsquo;t set BypassPolicyLockoutSafetyCheck to True, the key policy\u003cbr/\u003e must allow the principal that is making the CreateKey request to make\u003cbr/\u003e a subsequent PutKeyPolicy request on the KMS key. This reduces the risk\u003cbr/\u003e that the KMS key becomes unmanageable. For more information, refer to\u003cbr/\u003e the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)\u003cbr/\u003e section of the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Each statement in the key policy must contain one or more principals.\u003cbr/\u003e The principals in the key policy must exist and be visible to KMS. When\u003cbr/\u003e you create a new Amazon Web Services principal (for example, an IAM user\u003cbr/\u003e or role), you might need to enforce a delay before including the new principal\u003cbr/\u003e in a key policy because the new principal might not be immediately visible\u003cbr/\u003e to KMS. For more information, see Changes that I make are not always immediately\u003cbr/\u003e visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)\u003cbr/\u003e in the Amazon Web Services Identity and Access Management User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA key policy document can include only the following characters:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Printable ASCII characters from the space character (\\u0020) through\u003cbr/\u003e the end of the ASCII character range.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special\u003cbr/\u003e characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)\u003cbr/\u003ein the Key Management Service Developer Guide. For help writing and formatting\u003cbr/\u003ea JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)\u003cbr/\u003ein the Identity and Access Management User Guide .\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAssigns one or more tags to the KMS key. Use this parameter to tag the KMS\u003cbr/\u003ekey when it is created. To tag an existing KMS key, use the TagResource operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTagging or untagging a KMS key can allow or deny permission to the KMS key.\u003cbr/\u003eFor details, see ABAC in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use this parameter, you must have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html)\u003cbr/\u003epermission in an IAM policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach tag consists of a tag key and a tag value. Both the tag key and the\u003cbr/\u003etag value are required, but the tag value can be an empty (null) string.\u003cbr/\u003eYou cannot have more than one tag on a KMS key with the same tag key. If\u003cbr/\u003eyou specify an existing tag key with a different tag value, KMS replaces\u003cbr/\u003ethe current tag value with the specified one.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you add tags to an Amazon Web Services resource, Amazon Web Services\u003cbr/\u003egenerates a cost allocation report with usage and costs aggregated by tags.\u003cbr/\u003eTags can also be used to control access to a KMS key. For details, see Tagging\u003cbr/\u003eKeys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair. A tag consists of a tag key and a tag value. Tag keys and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etag values are both required, but tag values can be empty (null) strings.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor information about the rules that apply to tag keys and tag values, see\nUser-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)\nin the Amazon Web Services Billing and Cost Management User Guide. || \u003cstrong\u003etags.[].tagKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].tagValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nawsAccountID: string\ncloudHsmClusterID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\ndeletionDate: string\nenabled: boolean\nencryptionAlgorithms:\n- string\nexpirationModel: string\nkeyID: string\nkeyManager: string\nkeyState: string\nmacAlgorithms:\n- string\nmultiRegionConfiguration: \n multiRegionKeyType: string\n primaryKey: \n arn: string\n region: string\n replicaKeys:\n - arn: string\n region: string\npendingDeletionWindowInDays: integer\nsigningAlgorithms:\n- string\nvalidTo: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eawsAccountID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe twelve-digit account ID of the Amazon Web Services account that owns\u003cbr/\u003ethe KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudHsmClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster ID of the CloudHSM cluster that contains the key material for\u003cbr/\u003ethe KMS key. When you create a KMS key in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),\u003cbr/\u003eKMS creates the key material for the KMS key in the associated CloudHSM cluster.\u003cbr/\u003eThis value is present only when the KMS key is created in a custom key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the KMS key was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time after which KMS deletes this KMS key. This value is present\u003cbr/\u003eonly when the KMS key is scheduled for deletion, that is, when its KeyState\u003cbr/\u003eis PendingDeletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the primary key in a multi-Region key is scheduled for deletion but\u003cbr/\u003estill has replica keys, its key state is PendingReplicaDeletion and the length\u003cbr/\u003eof its waiting period is displayed in the PendingDeletionWindowInDays field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the KMS key is enabled. When KeyState is Enabled this value\u003cbr/\u003eis true, otherwise it is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe encryption algorithms that the KMS key supports. You cannot use the KMS\u003cbr/\u003ekey with other encryption algorithms within KMS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe globally unique identifier for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyManager\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe manager of the KMS key. KMS keys in your Amazon Web Services account\u003cbr/\u003eare either customer managed or Amazon Web Services managed. For more information\u003cbr/\u003eabout the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about how key state affects the use of a KMS key, see\u003cbr/\u003eKey states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emacAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe message authentication code (MAC) algorithm that the HMAC KMS key supports.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emacAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.multiRegionKeyType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the primary or replica key in a multi-Region key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the primary or replica key in a multi-Region key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeletionWindowInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe waiting period before the primary key in a multi-Region key is deleted.\u003cbr/\u003eThis waiting period begins when the last of its replica keys is deleted.\u003cbr/\u003eThis value is present only when the KeyState of the KMS key is PendingReplicaDeletion.\u003cbr/\u003eThat indicates that the KMS key is the primary key in a multi-Region key,\u003cbr/\u003eit is scheduled for deletion, and it still has existing replica keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a single-Region KMS key or a multi-Region replica key is scheduled for\u003cbr/\u003edeletion, its deletion date is displayed in the DeletionDate field. However,\u003cbr/\u003ewhen the primary key in a multi-Region key is scheduled for deletion, its\u003cbr/\u003ewaiting period doesn\u0026rsquo;t begin until all of its replica keys are deleted. This\u003cbr/\u003evalue displays that waiting period. When the last replica key in the multi-Region\u003cbr/\u003ekey is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion\u003cbr/\u003eto PendingDeletion and the deletion date appears in the DeletionDate field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe signing algorithms that the KMS key supports. You cannot use the KMS\u003cbr/\u003ekey with other signing algorithms within KMS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:119,href:"https://aws-controllers-k8s.github.io/community/reference/keyspaces/v1alpha1/keyspace/",title:"Keyspace",description:null,content:'\u003cp\u003e\u003ccode\u003ekeyspaces.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/keyspaces-controller/apis/v1alpha1#Keyspace"\u003ekeyspaces-controller/apis/v1alpha1#Keyspace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyspaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeyspaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeyspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ekeyspaceName: string\nreplicationSpecification: \n regionList:\n - string\n replicationStrategy: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyspaceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the keyspace to be created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe replication specification of the keyspace includes:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * regionList - if the replicationStrategy is MULTI_REGION, the regionList\u003cbr/\u003e requires the current Region and at least one additional Amazon Web Services\u003cbr/\u003e Region where the keyspace is going to be replicated in. The maximum number\u003cbr/\u003e of supported replication Regions including the current Region is six.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification.regionList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification.regionList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pair tags to be attached to the keyspace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\u003cbr/\u003e(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea single Amazon Keyspaces resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\n(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\nin the Amazon Keyspaces Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nresourceARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier of the keyspace in the format of an Amazon Resource\u003cbr/\u003eName (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:120,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/layerversion/",title:"LayerVersion",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#LayerVersion"\u003elambda-controller/apis/v1alpha1#LayerVersion\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLayerVersion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLayerVersionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003elayerversions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003elayerversion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecompatibleArchitectures:\n- string\ncompatibleRuntimes:\n- string\ncontent: \n s3Bucket: string\n s3Key: string\n s3ObjectVersion: string\n zipFile: string\ndescription: string\nlayerName: string\nlicenseInfo: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleArchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleArchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleRuntimes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3Bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3Key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3ObjectVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.zipFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the layer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe layer\u0026rsquo;s software license. It can be any of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * An SPDX license identifier (https://spdx.org/licenses/). For example,\u003cbr/\u003e MIT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The full text of the license.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nlayerARN: string\nversionNumber: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the layer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe version number.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:121,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/loggingconfiguration/",title:"LoggingConfiguration",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#LoggingConfiguration"\u003eprometheusservice-controller/apis/v1alpha1#LoggingConfiguration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLoggingConfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLoggingConfigurationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggingconfigurations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggingconfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003elogGroupARN: string\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogGroupARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the CW log group to which the vended log data will be published.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace to vend logs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatusCode: string\nstatusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus code of the logging configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for failure if any.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:122,href:"https://aws-controllers-k8s.github.io/community/reference/cloudwatchlogs/v1alpha1/loggroup/",title:"LogGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudwatchlogs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudwatchlogs-controller/apis/v1alpha1#LogGroup"\u003ecloudwatchlogs-controller/apis/v1alpha1#LogGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLogGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLogGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a log group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ekmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nname: string\nretentionDays: integer\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the KMS key to use when encrypting log\u003cbr/\u003edata. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe key-value pairs to use for the tags.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can grant users access to certain log groups while preventing them from\u003cbr/\u003eaccessing other log groups. To do so, tag your groups and use IAM policies\u003cbr/\u003ethat refer to those tags. To assign tags when you create a log group, you\u003cbr/\u003emust have either the logs:TagResource or logs:TagLogGroup permission. For\u003cbr/\u003emore information about tagging, see Tagging Amazon Web Services resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For more\u003cbr/\u003einformation about using tags to control access, see Controlling access to\u003cbr/\u003eAmazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: integer\ndataProtectionStatus: string\nmetricFilterCount: integer\nretentionInDays: integer\nstoredBytes: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe creation time of the log group, expressed as the number of milliseconds\u003cbr/\u003eafter Jan 1, 1970 00:00:00 UTC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProtectionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDisplays whether this log group has a protection policy, or whether it had\u003cbr/\u003eone in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetricFilterCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of metric filters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoredBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of bytes stored.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:123,href:"https://aws-controllers-k8s.github.io/community/reference/cloudwatch/v1alpha1/metricalarm/",title:"MetricAlarm",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudwatch.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudwatch-controller/apis/v1alpha1#MetricAlarm"\u003ecloudwatch-controller/apis/v1alpha1#MetricAlarm\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMetricAlarm\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMetricAlarmList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emetricalarms\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emetricalarm\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details about a metric alarm.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eactionsEnabled: boolean\nalarmActions:\n- string\nalarmDescription: string\ncomparisonOperator: string\ndatapointsToAlarm: integer\ndimensions:\n- name: string\n value: string\nevaluateLowSampleCountPercentile: string\nevaluationPeriods: integer\nextendedStatistic: string\ninsufficientDataActions:\n- string\nmetricName: string\nmetrics:\n- accountID: string\n expression: string\n id: string\n label: string\n metricStat: \n metric: \n dimensions:\n - name: string\n value: string\n metricName: string\n namespace: string\n period: integer\n stat: string\n unit: string\n period: integer\n returnData: boolean\nname: string\nnamespace: string\noKActions:\n- string\nperiod: integer\nstatistic: string\ntags:\n- key: string\n value: string\nthreshold: number\nthresholdMetricID: string\ntreatMissingData: string\nunit: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactionsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether actions should be executed during any changes to the alarm\u003cbr/\u003estate. The default is TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarmActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to the ALARM state from\u003cbr/\u003eany other state. Each action is specified as an Amazon Resource Name (ARN).\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarmActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomparisonOperator\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe arithmetic operation to use when comparing the specified statistic and\u003cbr/\u003ethreshold. The specified statistic value is used as the first operand.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold,\u003cbr/\u003eand GreaterThanUpperThreshold are used only for alarms based on anomaly detection\u003cbr/\u003emodels.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatapointsToAlarm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of data points that must be breaching to trigger the alarm. This\u003cbr/\u003eis used only if you are setting an \u0026ldquo;M out of N\u0026rdquo; alarm. In that case, this\u003cbr/\u003evalue is the M. For more information, see Evaluating an Alarm (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation)\u003cbr/\u003ein the Amazon CloudWatch User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edimensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe dimensions for the metric specified in MetricName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dimension is a name/value pair that is part of the identity of a metric.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eBecause dimensions are part of the unique identifier for a metric, whenever\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou add a unique name/value pair to one of your metrics, you are creating\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea new variation of that metric. For example, many Amazon EC2 metrics publish\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eInstanceId as a dimension name, and the actual instance ID as the value for\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat dimension.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can assign up to 30 dimensions to a metric. || \u003cstrong\u003edimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevaluateLowSampleCountPercentile\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUsed only for alarms based on percentiles. If you specify ignore, the alarm\u003cbr/\u003estate does not change during periods with too few data points to be statistically\u003cbr/\u003esignificant. If you specify evaluate or omit this parameter, the alarm is\u003cbr/\u003ealways evaluated and possibly changes state no matter how many data points\u003cbr/\u003eare available. For more information, see Percentile-Based CloudWatch Alarms\u003cbr/\u003eand Low Data Samples (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: evaluate | ignore |\n| \u003cstrong\u003eevaluationPeriods\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of periods over which data is compared to the specified threshold.\u003cbr/\u003eIf you are setting an alarm that requires that a number of consecutive data\u003cbr/\u003epoints be breaching to trigger the alarm, this value specifies that number.\u003cbr/\u003eIf you are setting an \u0026ldquo;M out of N\u0026rdquo; alarm, this value is the N.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn alarm\u0026rsquo;s total current evaluation period can be no longer than one day,\u003cbr/\u003eso this number multiplied by Period cannot be more than 86,400 seconds. |\n| \u003cstrong\u003eextendedStatistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe extended statistic for the metric specified in MetricName. When you call\u003cbr/\u003ePutMetricAlarm and specify a MetricName, you must specify either Statistic\u003cbr/\u003eor ExtendedStatistic but not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify ExtendedStatistic, the following are valid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * p90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * tm90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * tc90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ts90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wm90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IQM\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PR(n:m) where n and m are values of the metric\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TC(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TM(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TS(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * WM(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about these extended statistics, see CloudWatch statistics\u003cbr/\u003edefinitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html). |\n| \u003cstrong\u003einsufficientDataActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA\u003cbr/\u003estate from any other state. Each action is specified as an Amazon Resource\u003cbr/\u003eName (ARN). Valid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |\n| \u003cstrong\u003einsufficientDataActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003emetricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the metric associated with the alarm. For each PutMetricAlarm\u003cbr/\u003eoperation, you must specify either MetricName or a Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are creating an alarm based on a math expression, you cannot specify\u003cbr/\u003ethis parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic,\u003cbr/\u003eor ExtendedStatistic parameters. Instead, you specify all this information\u003cbr/\u003ein the Metrics array. |\n| \u003cstrong\u003emetrics\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of MetricDataQuery structures that enable you to create an alarm\u003cbr/\u003ebased on the result of a metric math expression. For each PutMetricAlarm\u003cbr/\u003eoperation, you must specify either MetricName or a Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach item in the Metrics array either retrieves a metric or performs a math\u003cbr/\u003eexpression.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOne item in the Metrics array is the expression that the alarm watches. You\u003cbr/\u003edesignate this expression by setting ReturnData to true for this object in\u003cbr/\u003ethe array. For more information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use the Metrics parameter, you cannot include the Namespace, MetricName,\u003cbr/\u003eDimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm\u003cbr/\u003ein the same operation. Instead, you retrieve the metrics you are using in\u003cbr/\u003eyour math expression as part of the Metrics array. |\n| \u003cstrong\u003emetrics.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure is used in both GetMetricData and PutMetricAlarm. The supported\nuse of this structure is different for those two operations.\u003c/p\u003e\n\u003cp\u003eWhen used in GetMetricData, it indicates the metric data to return, and whether\nthis call is just retrieving a batch set of data for one metric, or is performing\na Metrics Insights query or a math expression. A single GetMetricData call\ncan include up to 500 MetricDataQuery structures.\u003c/p\u003e\n\u003cp\u003eWhen used in PutMetricAlarm, it enables you to create an alarm based on a\nmetric math expression. Each MetricDataQuery in the array specifies either\na metric to retrieve, or a math expression to be performed on retrieved metrics.\nA single PutMetricAlarm call can include up to 20 MetricDataQuery structures\nin the array. The 20 structures can include as many as 10 structures that\ncontain a MetricStat parameter to retrieve a metric, and as many as 10 structures\nthat contain the Expression parameter to perform a math expression. Of those\nExpression structures, one must have true as the value for ReturnData. The\nresult of this expression is the value the alarm watches.\u003c/p\u003e\n\u003cp\u003eAny expression used in a PutMetricAlarm operation must return a single time\nseries. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)\nin the Amazon CloudWatch User Guide.\u003c/p\u003e\n\u003cp\u003eSome of the parameters of this structure also have different uses whether\nyou are using this structure in a GetMetricData operation or a PutMetricAlarm\noperation. These differences are explained in the following parameter list. || \u003cstrong\u003emetrics.[].accountID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].label\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure defines the metric to be returned, along with the statistics,\u003cbr/\u003eperiod, and units. |\n| \u003cstrong\u003emetrics.[].metricStat.metric\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a specific metric. |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dimension is a name/value pair that is part of the identity of a metric.\nBecause dimensions are part of the unique identifier for a metric, whenever\nyou add a unique name/value pair to one of your metrics, you are creating\na new variation of that metric. For example, many Amazon EC2 metrics publish\nInstanceId as a dimension name, and the actual instance ID as the value for\nthat dimension.\u003c/p\u003e\n\u003cp\u003eYou can assign up to 30 dimensions to a metric. || \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.period\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.stat\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].period\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].returnData\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the alarm. This name must be unique within the Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name must contain only UTF-8 characters, and can\u0026rsquo;t contain ASCII control\u003cbr/\u003echaracters |\n| \u003cstrong\u003enamespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace for the metric associated specified in MetricName. |\n| \u003cstrong\u003eoKActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to an OK state from any\u003cbr/\u003eother state. Each action is specified as an Amazon Resource Name (ARN). Valid\u003cbr/\u003evalues:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |\n| \u003cstrong\u003eoKActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eperiod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe length, in seconds, used each time the metric specified in MetricName\u003cbr/\u003eis evaluated. Valid values are 10, 30, and any multiple of 60.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePeriod is required for alarms based on static thresholds. If you are creating\u003cbr/\u003ean alarm based on a metric math expression, you specify the period for each\u003cbr/\u003emetric within the objects in the Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBe sure to specify 10 or 30 only for metrics that are stored by a PutMetricData\u003cbr/\u003ecall with a StorageResolution of 1. If you specify a period of 10 or 30 for\u003cbr/\u003ea metric that does not have sub-minute resolution, the alarm still attempts\u003cbr/\u003eto gather data at the period rate that you specify. In this case, it does\u003cbr/\u003enot receive data for the attempts that do not correspond to a one-minute\u003cbr/\u003edata resolution, and the alarm might often lapse into INSUFFICENT_DATA status.\u003cbr/\u003eSpecifying 10 or 30 also sets this alarm as a high-resolution alarm, which\u003cbr/\u003ehas a higher charge than other alarms. For more information about pricing,\u003cbr/\u003esee Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn alarm\u0026rsquo;s total current evaluation period can be no longer than one day,\u003cbr/\u003eso Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. |\n| \u003cstrong\u003estatistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe statistic for the metric specified in MetricName, other than percentile.\u003cbr/\u003eFor percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm\u003cbr/\u003eand specify a MetricName, you must specify either Statistic or ExtendedStatistic,\u003cbr/\u003ebut not both. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pairs to associate with the alarm. You can associate\u003cbr/\u003eas many as 50 tags with an alarm. To be able to associate tags with the alarm\u003cbr/\u003ewhen you create the alarm, you must have the cloudwatch:TagResource permission.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags can help you organize and categorize your resources. You can also use\u003cbr/\u003ethem to scope user permissions by granting a user permission to access or\u003cbr/\u003echange only resources with certain tag values.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using this operation to update an existing alarm, any tags you\u003cbr/\u003especify in this parameter are ignored. To change the tags of an existing\u003cbr/\u003ealarm, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html)\u003cbr/\u003eor UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with a CloudWatch resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethreshold\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003eThe value against which the specified statistic is compared.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for alarms based on static thresholds, but should\u003cbr/\u003enot be used for alarms based on anomaly detection models. |\n| \u003cstrong\u003ethresholdMetricID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf this is an alarm based on an anomaly detection model, make this value\u003cbr/\u003ematch the ID of the ANOMALY_DETECTION_BAND function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor an example of how to use this parameter, see the Anomaly Detection Model\u003cbr/\u003eAlarm example on this page.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your alarm uses this parameter, it cannot have Auto Scaling actions. |\n| \u003cstrong\u003etreatMissingData\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSets how this alarm is to handle missing data points. If TreatMissingData\u003cbr/\u003eis omitted, the default behavior of missing is used. For more information,\u003cbr/\u003esee Configuring How CloudWatch Alarms Treats Missing Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: breaching | notBreaching | ignore | missing\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\u003cbr/\u003emissing data even if you choose a different option for TreatMissingData.\u003cbr/\u003eWhen an AWS/DynamoDB metric has missing data, alarms that evaluate that metric\u003cbr/\u003eremain in their current state. |\n| \u003cstrong\u003eunit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unit of measure for the statistic. For example, the units for the Amazon\u003cbr/\u003eEC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes\u003cbr/\u003ethat an instance receives on all network interfaces. You can also specify\u003cbr/\u003ea unit when you create a custom metric. Units help provide conceptual meaning\u003cbr/\u003eto your data. Metric data points that specify a unit of measure, such as\u003cbr/\u003ePercent, are aggregated separately. If you are creating an alarm based on\u003cbr/\u003ea metric math expression, you can specify the unit for each metric (if needed)\u003cbr/\u003ewithin the objects in the Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify Unit, CloudWatch retrieves all unit types that have\u003cbr/\u003ebeen published for the metric and attempts to evaluate the alarm. Usually,\u003cbr/\u003emetrics are published with only one unit, so the alarm works as intended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eHowever, if the metric is published with multiple types of units and you\u003cbr/\u003edon\u0026rsquo;t specify a unit, the alarm\u0026rsquo;s behavior is not defined and it behaves\u003cbr/\u003eunpredictably.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend omitting Unit so that you don\u0026rsquo;t inadvertently specify an incorrect\u003cbr/\u003eunit that is not published for this metric. Doing so causes the alarm to\u003cbr/\u003ebe stuck in the INSUFFICIENT DATA state. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:124,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/model/",title:"Model",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Model"\u003esagemaker-controller/apis/v1alpha1#Model\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModel\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodels\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodel\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe properties of a model as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html)\nAPI.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainers:\n- containerHostname: string\n environment: {}\n image: string\n imageConfig: \n repositoryAccessMode: string\n repositoryAuthConfig: \n repositoryCredentialsProviderARN: string\n inferenceSpecificationName: string\n mode: string\n modelDataSource: \n s3DataSource: \n compressionType: string\n modelAccessConfig: \n acceptEula: boolean\n s3DataType: string\n s3URI: string\n modelDataURL: string\n modelPackageName: string\n multiModelConfig: \n modelCacheSetting: string\nenableNetworkIsolation: boolean\nexecutionRoleARN: string\ninferenceExecutionConfig: \n mode: string\nmodelName: string\nprimaryContainer: \n containerHostname: string\n environment: {}\n image: string\n imageConfig: \n repositoryAccessMode: string\n repositoryAuthConfig: \n repositoryCredentialsProviderARN: string\n inferenceSpecificationName: string\n mode: string\n modelDataSource: \n s3DataSource: \n compressionType: string\n modelAccessConfig: \n acceptEula: boolean\n s3DataType: string\n s3URI: string\n modelDataURL: string\n modelPackageName: string\n multiModelConfig: \n modelCacheSetting: string\ntags:\n- key: string\n value: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the containers in the inference pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the container, as part of model definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the model container is in Amazon ECR or a private Docker\u003cbr/\u003eregistry accessible from your Amazon Virtual Private Cloud (VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAuthConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an authentication configuration for the private docker registry\u003cbr/\u003ewhere your model image is hosted. Specify a value for this property only\u003cbr/\u003eif you specified Vpc as the value for the RepositoryAccessMode field of the\u003cbr/\u003eImageConfig object that you passed to a call to CreateModel and the private\u003cbr/\u003eDocker registry where the model image is hosted requires authentication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAuthConfig.repositoryCredentialsProviderARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].inferenceSpecificationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the location of ML model data to deploy. If specified, you must\u003cbr/\u003especify one and only one of the available data sources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 location of ML model data to deploy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.modelAccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration file to control access to the ML model. You can\u003cbr/\u003eexplicitly accept the model end-user license agreement (EULA) within the\u003cbr/\u003eModelAccessConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula)\u003cbr/\u003e section for more details on accepting the EULA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are an AutoML user, see the Optional Parameters section of Create\u003cbr/\u003e an AutoML job to fine-tune text generation models using the API for details\u003cbr/\u003e on How to set the EULA acceptance when fine-tuning a model using the AutoML\u003cbr/\u003e API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.modelAccessConfig.acceptEula\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].multiModelConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional configuration for hosting multi-model endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].multiModelConfig.modelCacheSetting\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIsolates the model container. No inbound or outbound network calls can be\u003cbr/\u003emade to or from the model container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that SageMaker can assume\u003cbr/\u003eto access model artifacts and docker image for deployment on ML compute instances\u003cbr/\u003eor for batch transform jobs. Deploying on ML compute instances is part of\u003cbr/\u003emodel hosting. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceExecutionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies details of how containers in a multi-container endpoint are called.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceExecutionConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe location of the primary docker image containing inference code, associated\u003cbr/\u003eartifacts, and custom environment map that the inference code uses when the\u003cbr/\u003emodel is deployed for predictions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the model container is in Amazon ECR or a private Docker\u003cbr/\u003eregistry accessible from your Amazon Virtual Private Cloud (VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAuthConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an authentication configuration for the private docker registry\u003cbr/\u003ewhere your model image is hosted. Specify a value for this property only\u003cbr/\u003eif you specified Vpc as the value for the RepositoryAccessMode field of the\u003cbr/\u003eImageConfig object that you passed to a call to CreateModel and the private\u003cbr/\u003eDocker registry where the model image is hosted requires authentication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAuthConfig.repositoryCredentialsProviderARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.inferenceSpecificationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the location of ML model data to deploy. If specified, you must\u003cbr/\u003especify one and only one of the available data sources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 location of ML model data to deploy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.modelAccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration file to control access to the ML model. You can\u003cbr/\u003eexplicitly accept the model end-user license agreement (EULA) within the\u003cbr/\u003eModelAccessConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula)\u003cbr/\u003e section for more details on accepting the EULA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are an AutoML user, see the Optional Parameters section of Create\u003cbr/\u003e an AutoML job to fine-tune text generation models using the API for details\u003cbr/\u003e on How to set the EULA acceptance when fine-tuning a model using the AutoML\u003cbr/\u003e API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.modelAccessConfig.acceptEula\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.multiModelConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional configuration for hosting multi-model endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.multiModelConfig.modelCacheSetting\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)\u003cbr/\u003eobject that specifies the VPC that you want your model to connect to. Control\u003cbr/\u003eaccess to and from your model container by configuring the VPC. VpcConfig\u003cbr/\u003eis used in hosting services and in batch transform. For more information,\u003cbr/\u003esee Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html)\u003cbr/\u003eand Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private\u003cbr/\u003eCloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:125,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelbiasjobdefinition/",title:"ModelBiasJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelBiasJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelBiasJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelBiasJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelBiasJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelbiasjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelbiasjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelBiasAppSpecification: \n configURI: string\n environment: {}\n imageURI: string\nmodelBiasBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelBiasJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n groundTruthS3Input: \n s3URI: string\nmodelBiasJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the bias job definition. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the model bias job to run a specified Docker container image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.configURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe baseline configuration for a model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInputs for the model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.groundTruthS3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ground truth labels for the dataset used for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.groundTruthS3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:126,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/",title:"ModelExplainabilityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelExplainabilityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelExplainabilityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelExplainabilityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelExplainabilityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelexplainabilityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelexplainabilityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelExplainabilityAppSpecification: \n configURI: string\n environment: {}\n imageURI: string\nmodelExplainabilityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelExplainabilityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\nmodelExplainabilityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model explainability job definition. The name must be unique\u003cbr/\u003ewithin an Amazon Web Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the model explainability job to run a specified Docker container\u003cbr/\u003eimage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.configURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe baseline configuration for a model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInputs for the model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:127,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelpackage/",title:"ModelPackage",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelPackage"\u003esagemaker-controller/apis/v1alpha1#ModelPackage\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackages\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA versioned model that can be deployed for SageMaker inference.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eadditionalInferenceSpecifications:\n containers:\n additionalS3DataSource: \n compressionType: string\n s3DataType: string\n s3URI: string\n containerHostname: string\n environment: {}\n framework: string\n frameworkVersion: string\n image: string\n imageDigest: string\n modelDataURL: string\n modelInput: \n dataInputConfig: string\n nearestModelName: string\n productID: string\n description: string\n name: string\n supportedContentTypes:\n - string\n supportedRealtimeInferenceInstanceTypes:\n - string\n supportedResponseMIMETypes:\n - string\n supportedTransformInstanceTypes:\n - string\napprovalDescription: string\ncertifyForMarketplace: boolean\nclientToken: string\ncustomerMetadataProperties: {}\ndomain: string\ndriftCheckBaselines: \n bias: \n configFile: \n contentDigest: string\n contentType: string\n s3URI: string\n postTrainingConstraints: \n contentDigest: string\n contentType: string\n s3URI: string\n preTrainingConstraints: \n contentDigest: string\n contentType: string\n s3URI: string\n explainability: \n configFile: \n contentDigest: string\n contentType: string\n s3URI: string\n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n modelDataQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\n modelQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\ninferenceSpecification: \n containers:\n additionalS3DataSource: \n compressionType: string\n s3DataType: string\n s3URI: string\n containerHostname: string\n environment: {}\n framework: string\n frameworkVersion: string\n image: string\n imageDigest: string\n modelDataURL: string\n modelInput: \n dataInputConfig: string\n nearestModelName: string\n productID: string\n supportedContentTypes:\n - string\n supportedRealtimeInferenceInstanceTypes:\n - string\n supportedResponseMIMETypes:\n - string\n supportedTransformInstanceTypes:\n - string\nmetadataProperties: \n commitID: string\n generatedBy: string\n projectID: string\n repository: string\nmodelApprovalStatus: string\nmodelMetrics: \n bias: \n postTrainingReport: \n contentDigest: string\n contentType: string\n s3URI: string\n preTrainingReport: \n contentDigest: string\n contentType: string\n s3URI: string\n report: \n contentDigest: string\n contentType: string\n s3URI: string\n explainability: \n report: \n contentDigest: string\n contentType: string\n s3URI: string\n modelDataQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\n modelQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\nmodelPackageDescription: string\nmodelPackageGroupName: string\nmodelPackageName: string\nsamplePayloadURL: string\nskipModelValidation: string\nsourceAlgorithmSpecification: \n sourceAlgorithms:\n - algorithmName: string\n modelDataURL: string\ntags:\n- key: string\n value: string\ntask: string\nvalidationSpecification: \n validationProfiles:\n - profileName: string\n transformJobDefinition: \n batchStrategy: string\n environment: {}\n maxConcurrentTransforms: integer\n maxPayloadInMB: integer\n transformInput: \n compressionType: string\n contentType: string\n dataSource: \n s3DataSource: \n s3DataType: string\n s3URI: string\n splitType: string\n transformOutput: \n accept: string\n assembleWith: string\n kmsKeyID: string\n s3OutputPath: string\n transformResources: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n validationRole: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of additional Inference Specification objects. Each additional Inference\u003cbr/\u003eSpecification specifies artifacts based on this model package that can be\u003cbr/\u003eused on inference endpoints. Generally used with SageMaker Neo to store the\u003cbr/\u003ecompiled artifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure of additional Inference Specification. Additional Inference Specification\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003especifies details about inference jobs that can be run with models based\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eon this model package\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the Docker container for the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].framework\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].frameworkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].imageDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelInput.dataInputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].nearestModelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedRealtimeInferenceInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedResponseMIMETypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedTransformInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertifyForMarketplace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhether to certify the model package for listing on Amazon Web Services Marketplace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional for unversioned models, and does not apply to\u003cbr/\u003eversioned models.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique token that guarantees that the call to this API is idempotent.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerMetadataProperties\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata properties associated with the model package versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe machine learning domain of your model package and its components. Common\u003cbr/\u003emachine learning domains include computer vision and natural language processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check baselines that can be used when the model monitor\u003cbr/\u003eis set using the model package. For more information, see the topic on Drift\u003cbr/\u003eDetection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection)\u003cbr/\u003ein the Amazon SageMaker Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check bias baselines that can be used when the model\u003cbr/\u003emonitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details regarding the file source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check explainability baselines that can be used when\u003cbr/\u003ethe model monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details regarding the file source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check data quality baselines that can be used when the\u003cbr/\u003emodel monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check model quality baselines that can be used when\u003cbr/\u003ethe model monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies details about inference jobs that can be run with models based\u003cbr/\u003eon this model package, including the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The Amazon ECR paths of containers that contain the inference code and\u003cbr/\u003e model artifacts.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The instance types that the model package supports for transform jobs\u003cbr/\u003e and real-time endpoints used for inference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The input and output content formats that the model package supports\u003cbr/\u003e for inference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the Docker container for the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].framework\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].frameworkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].imageDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelInput.dataInputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].nearestModelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedRealtimeInferenceInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedResponseMIMETypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedTransformInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.commitID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.generatedBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.projectID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.repository\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelApprovalStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether the model is approved for deployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional for versioned models, and does not apply to unversioned\u003cbr/\u003emodels.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor versioned models, the value of this parameter must be set to Approved\u003cbr/\u003eto deploy the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that contains model metrics reports.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains bias metrics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains explainability metrics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eData quality constraints and statistics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eModel quality statistics and constraints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the model package group that this\u003cbr/\u003emodel version belongs to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for versioned models, and does not apply to unversioned\u003cbr/\u003emodels.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model package. The name must have 1 to 63 characters. Valid\u003cbr/\u003echaracters are a-z, A-Z, 0-9, and - (hyphen).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for unversioned models. It is not applicable to\u003cbr/\u003eversioned models.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esamplePayloadURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Simple Storage Service (Amazon S3) path where the sample payload\u003cbr/\u003eis stored. This path must point to a single gzip compressed tar archive (.tar.gz\u003cbr/\u003esuffix). This archive can hold multiple files that are all equally used in\u003cbr/\u003ethe load test. Each file in the archive must satisfy the size constraints\u003cbr/\u003eof the InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax)\u003cbr/\u003ecall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eskipModelValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates if you want to skip model validation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the algorithm that was used to create the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an algorithm that was used to create the model package. The algorithm\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emust be either an algorithm resource in your SageMaker account or an algorithm\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Amazon Web Services Marketplace that you are subscribed to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key value pairs associated with the model. For more information,\u003cbr/\u003esee Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you supply ModelPackageGroupName, your model package belongs to the model\u003cbr/\u003egroup you specify and uses the tags associated with the model group. In this\u003cbr/\u003ecase, you cannot supply a tag argument.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etask\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe machine learning task your model package accomplishes. Common machine\u003cbr/\u003elearning tasks include object detection and image classification. The following\u003cbr/\u003etasks are supported by Inference Recommender: \u0026ldquo;IMAGE_CLASSIFICATION\u0026rdquo; | \u0026ldquo;OBJECT_DETECTION\u0026rdquo;\u003cbr/\u003e| \u0026ldquo;TEXT_GENERATION\u0026rdquo; |\u0026ldquo;IMAGE_SEGMENTATION\u0026rdquo; | \u0026ldquo;FILL_MASK\u0026rdquo; | \u0026ldquo;CLASSIFICATION\u0026rdquo;\u003cbr/\u003e| \u0026ldquo;REGRESSION\u0026rdquo; | \u0026ldquo;OTHER\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify \u0026ldquo;OTHER\u0026rdquo; if none of the tasks listed fit your use case. |\n| \u003cstrong\u003evalidationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configurations for one or more transform jobs that SageMaker runs\u003cbr/\u003eto test the model package. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains data, such as the inputs and targeted instance types that are used\nin the process of validating the model package.\u003c/p\u003e\n\u003cp\u003eThe data provided in the validation profile is made available to your buyers\non Amazon Web Services Marketplace. || \u003cstrong\u003evalidationSpecification.validationProfiles.[].profileName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the input needed to run a transform job using the inference specification\u003cbr/\u003especified in the algorithm. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.batchStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.environment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.maxConcurrentTransforms\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.maxPayloadInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the input source of a transform job and the way the transform job\u003cbr/\u003econsumes it. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.splitType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of a transform job. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.accept\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.assembleWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including ML instance types and ML instance count,\u003cbr/\u003eto use for transform job. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationRole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\nmodelPackageStatus: string\nmodelPackageStatusDetails: \n imageScanStatuses:\n - failureReason: string\n name: string\n status: string\n validationStatuses:\n - failureReason: string\n name: string\n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp specifying when the model package was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe last time that the model package was modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the current status of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the overall status of a model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the overall status of a model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:128,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelpackagegroup/",title:"ModelPackageGroup",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelPackageGroup"\u003esagemaker-controller/apis/v1alpha1#ModelPackageGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackagegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackagegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA group of versioned models in the model registry.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emodelPackageGroupDescription: string\nmodelPackageGroupName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key value pairs associated with the model group. For more information,\u003cbr/\u003esee Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nmodelPackageGroupStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:129,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelqualityjobdefinition/",title:"ModelQualityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelQualityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelQualityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelQualityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelQualityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelqualityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelqualityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelQualityAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n environment: {}\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n problemType: string\n recordPreprocessorSourceURI: string\nmodelQualityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelQualityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n groundTruthS3Input: \n s3URI: string\nmodelQualityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the monitoring job definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container that runs the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.problemType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the constraints and baselines for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the inputs that are monitored. Currently endpoints are supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.groundTruthS3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ground truth labels for the dataset used for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.groundTruthS3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the network configuration for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:130,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/monitoringschedule/",title:"MonitoringSchedule",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#MonitoringSchedule"\u003esagemaker-controller/apis/v1alpha1#MonitoringSchedule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMonitoringSchedule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMonitoringScheduleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emonitoringschedules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emonitoringschedule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA schedule for a model monitoring job. For information about model monitor,\nsee Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emonitoringScheduleConfig: \n monitoringJobDefinition: \n baselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\n statisticsResource: \n s3URI: string\n environment: {}\n monitoringAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n recordPreprocessorSourceURI: string\n monitoringInputs:\n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n monitoringOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\n monitoringResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n networkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n roleARN: string\n stoppingCondition: \n maxRuntimeInSeconds: integer\n monitoringJobDefinitionName: string\n monitoringType: string\n scheduleConfig: \n dataAnalysisEndTime: string\n dataAnalysisStartTime: string\n scheduleExpression: string\nmonitoringScheduleName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration object that specifies the monitoring schedule and defines\u003cbr/\u003ethe monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for monitoring constraints and monitoring statistics. These\u003cbr/\u003ebaseline resources are compared against the results of the current job from\u003cbr/\u003ethe series of jobs scheduled to collect data periodically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe statistics resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer image configuration object for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inputs for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a job, such as network traffic encryption between\u003cbr/\u003econtainers, whether to allow inbound and outbound network calls to and from\u003cbr/\u003econtainers, and the VPC subnets and security groups to use for VPC-enabled\u003cbr/\u003ejobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.stoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.stoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration details about the monitoring schedule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.dataAnalysisEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.dataAnalysisStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.scheduleExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the monitoring schedule. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region within an Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfailureReason: string\nlastModifiedTime: string\nlastMonitoringExecutionSummary: \n creationTime: string\n endpointName: string\n failureReason: string\n lastModifiedTime: string\n monitoringExecutionStatus: string\n monitoringJobDefinitionName: string\n monitoringScheduleName: string\n monitoringType: string\n processingJobARN: string\n scheduledTime: string\nmonitoringScheduleStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the monitoring job was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string, up to one KB in size, that contains the reason a monitoring job\u003cbr/\u003efailed, if it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the monitoring job was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes metadata on the last execution to run, if there was one.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringExecutionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringScheduleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.processingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.scheduledTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of an monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:131,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/mounttarget/",title:"MountTarget",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#MountTarget"\u003eefs-controller/apis/v1alpha1#MountTarget\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMountTarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMountTargetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emounttargets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emounttarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efileSystemID: string\nfileSystemRef: \n from: \n name: string\nipAddress: string\nsecurityGroupRefs:\n from: \n name: string\nsecurityGroups:\n- string\nsubnetID: string\nsubnetRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the file system for which to create the mount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eValid IPv4 address within the address range of the specified subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eUp to five VPC security group IDs, of the form sg-xxxxxxxx. These must be\u003cbr/\u003efor the same VPC as subnet specified. |\n| \u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the subnet to add the mount target in. For One Zone file systems,\u003cbr/\u003euse the subnet that is associated with the file system\u0026rsquo;s Availability Zone. |\n| \u003cstrong\u003esubnetRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003esubnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003esubnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZoneID: string\navailabilityZoneName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlifeCycleState: string\nmountTargetID: string\nnetworkInterfaceID: string\nownerID: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique and consistent identifier of the Availability Zone that the mount\u003cbr/\u003etarget resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region\u003cbr/\u003eand it has the same location in every Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Availability Zone in which the mount target is located. Availability\u003cbr/\u003eZones are independently mapped to names for each Amazon Web Services account.\u003cbr/\u003eFor example, the Availability Zone us-east-1a for your Amazon Web Services\u003cbr/\u003eaccount might not be the same location as us-east-1a for another Amazon Web\u003cbr/\u003eServices account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLifecycle state of the mount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emountTargetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSystem-assigned mount target ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the network interface that Amazon EFS created when it created the\u003cbr/\u003emount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services account ID that owns the resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtual private cloud (VPC) ID that the mount target is configured in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:132,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/natgateway/",title:"NATGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#NATGateway"\u003eec2-controller/apis/v1alpha1#NATGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNATGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNATGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enatgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enatgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a NAT gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocationID: string\nallocationRef: \n from: \n name: string\nconnectivityType: string\nsubnetID: string\nsubnetRef: \n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[Public NAT gateways only] The allocation ID of an Elastic IP address to\u003cbr/\u003eassociate with the NAT gateway. You cannot specify an Elastic IP address\u003cbr/\u003ewith a private NAT gateway. If the Elastic IP address is associated with\u003cbr/\u003eanother resource, you must first disassociate it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectivityType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the NAT gateway supports public or private connectivity.\u003cbr/\u003eThe default is public connectivity.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe subnet in which to create the NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateTime: string\ndeleteTime: string\nfailureCode: string\nfailureMessage: string\nnatGatewayAddresses:\n- allocationID: string\n networkInterfaceID: string\n privateIP: string\n publicIP: string\nnatGatewayID: string\nprovisionedBandwidth: \n provisionTime: string\n provisioned: string\n requestTime: string\n requested: string\n status: string\nstate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time the NAT gateway was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleteTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time the NAT gateway was deleted, if applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the NAT gateway could not be created, specifies the error code for the\u003cbr/\u003efailure. (InsufficientFreeAddressesInSubnet\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the NAT gateway could not be created, specifies the error message for\u003cbr/\u003ethe failure, that corresponds to the error code.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InsufficientFreeAddressesInSubnet: \u0026ldquo;Subnet has insufficient free\u003cbr/\u003e addresses to create this NAT gateway\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For Gateway.NotAttached: \u0026ldquo;Network vpc-xxxxxxxx has no Internet gateway\u003cbr/\u003e attached\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InvalidAllocationID.NotFound: \u0026ldquo;Elastic IP address eipalloc-xxxxxxxx\u003cbr/\u003e could not be associated with this NAT gateway\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For Resource.AlreadyAssociated: \u0026ldquo;Elastic IP address eipalloc-xxxxxxxx\u003cbr/\u003e is already associated\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InternalError: \u0026ldquo;Network interface eni-xxxxxxxx, created and used\u003cbr/\u003e internally by this NAT gateway is in an invalid state. Please try again.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InvalidSubnetID.NotFound: \u0026ldquo;The specified subnet subnet-xxxxxxxx\u003cbr/\u003e does not exist or could not be found.\u0026rdquo;\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IP addresses and network interface associated with\u003cbr/\u003ethe NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IP addresses and network interface associated with a NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].privateIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].publicIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReserved. If you need to sustain traffic greater than the documented limits\u003cbr/\u003e(https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html),\u003cbr/\u003econtact us through the Support Center (https://console.aws.amazon.com/support/home?).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.provisionTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.provisioned\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.requestTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.requested\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the NAT gateway.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pending: The NAT gateway is being created and is not ready to process\u003cbr/\u003e traffic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * failed: The NAT gateway could not be created. Check the failureCode\u003cbr/\u003e and failureMessage fields for the reason.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * available: The NAT gateway is able to process traffic. This status remains\u003cbr/\u003e until you delete the NAT gateway, and does not indicate the health of\u003cbr/\u003e the NAT gateway.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * deleting: The NAT gateway is in the process of being terminated and\u003cbr/\u003e may still be processing traffic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * deleted: The NAT gateway has been terminated and is no longer processing\u003cbr/\u003e traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC in which the NAT gateway is located.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:133,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/networkacl/",title:"NetworkACL",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#NetworkACL"\u003eec2-controller/apis/v1alpha1#NetworkACL\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNetworkACL\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNetworkACLList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enetworkacls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enetworkacl\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a network ACL.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassociations:\n- networkACLAssociationID: string\n networkACLID: string\n subnetID: string\n subnetRef: \n from: \n name: string\nentries:\n- cidrBlock: string\n egress: boolean\n icmpTypeCode: \n code: integer\n type_: integer\n ipv6CIDRBlock: string\n portRange: \n from: integer\n to: integer\n protocol: string\n ruleAction: string\n ruleNumber: integer\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a network ACL and a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].networkACLID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an entry in a network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].egress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].icmpTypeCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the ICMP type and code.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].icmpTypeCode.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**entries.[].icmpTypeCode.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a range of ports.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange.to\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].protocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ruleAction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ruleNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nisDefault: boolean\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisDefault\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is the default network ACL for the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:134,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/nodegroup/",title:"Nodegroup",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Nodegroup"\u003eeks-controller/apis/v1alpha1#Nodegroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNodegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNodegroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enodegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enodegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Amazon EKS managed node group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamiType: string\ncapacityType: string\nclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\ndiskSize: integer\ninstanceTypes:\n- string\nlabels: {}\nlaunchTemplate: \n id: string\n name: string\n version: string\nname: string\nnodeRole: string\nnodeRoleRef: \n from: \n name: string\nreleaseVersion: string\nremoteAccess: \n ec2SshKey: string\n sourceSecurityGroupRefs:\n from: \n name: string\n sourceSecurityGroups:\n - string\nscalingConfig: \n desiredSize: integer\n maxSize: integer\n minSize: integer\nsubnetRefs:\n from: \n name: string\nsubnets:\n- string\ntags: {}\ntaints:\n- effect: string\n key: string\n value: string\nupdateConfig: \n maxUnavailable: integer\n maxUnavailablePercentage: integer\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamiType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AMI type for your node group. If you specify launchTemplate, and your\u003cbr/\u003elaunch template uses a custom AMI, then don\u0026rsquo;t specify amiType, or the node\u003cbr/\u003egroup deployment will fail. If your launch template uses a Windows custom\u003cbr/\u003eAMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the\u003cbr/\u003eaws-auth ConfigMap. For more information about using launch templates with\u003cbr/\u003eAmazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe capacity type for your node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ediskSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe root device disk size (in GiB) for your node group instances. The default\u003cbr/\u003edisk size is 20 GiB for Linux and Bottlerocket. The default disk size is\u003cbr/\u003e50 GiB for Windows. If you specify launchTemplate, then don\u0026rsquo;t specify diskSize,\u003cbr/\u003eor the node group deployment will fail. For more information about using\u003cbr/\u003elaunch templates with Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecify the instance types for a node group. If you specify a GPU instance\u003cbr/\u003etype, make sure to also specify an applicable GPU AMI type with the amiType\u003cbr/\u003eparameter. If you specify launchTemplate, then you can specify zero or one\u003cbr/\u003einstance type in your launch template or you can specify 0-20 instance types\u003cbr/\u003efor instanceTypes. If however, you specify an instance type in your launch\u003cbr/\u003etemplate and specify any instanceTypes, the node group deployment will fail.\u003cbr/\u003eIf you don\u0026rsquo;t specify an instance type in a launch template or for instanceTypes,\u003cbr/\u003ethen t3.medium is used, by default. If you specify Spot for capacityType,\u003cbr/\u003ethen we recommend specifying multiple values for instanceTypes. For more\u003cbr/\u003einformation, see Managed node group capacity types (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types)\u003cbr/\u003eand Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a node group\u0026rsquo;s launch template specification. If specified,\u003cbr/\u003ethen do not specify instanceTypes, diskSize, or remoteAccess and make sure\u003cbr/\u003ethat the launch template meets the requirements in launchTemplateSpecification.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.version\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique name to give your node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to associate with your node\u003cbr/\u003egroup. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web\u003cbr/\u003eServices APIs on your behalf. Nodes receive permissions for these API calls\u003cbr/\u003ethrough an IAM instance profile and associated policies. Before you can launch\u003cbr/\u003enodes and register them into a cluster, you must create an IAM role for those\u003cbr/\u003enodes to use when they are launched. For more information, see Amazon EKS\u003cbr/\u003enode IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html)\u003cbr/\u003ein the Amazon EKS User Guide . If you specify launchTemplate, then don\u0026rsquo;t\u003cbr/\u003especify IamInstanceProfile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)\u003cbr/\u003ein your launch template, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereleaseVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AMI version of the Amazon EKS optimized AMI to use with your node group.\u003cbr/\u003eBy default, the latest available AMI version for the node group\u0026rsquo;s current\u003cbr/\u003eKubernetes version is used. For information about Linux versions, see Amazon\u003cbr/\u003eEKS optimized Amazon Linux AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide. Amazon EKS managed node groups support the\u003cbr/\u003eNovember 2022 and later releases of the Windows AMIs. For information about\u003cbr/\u003eWindows versions, see Amazon EKS optimized Windows AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify launchTemplate, and your launch template uses a custom AMI,\u003cbr/\u003ethen don\u0026rsquo;t specify releaseVersion, or the node group deployment will fail.\u003cbr/\u003eFor more information about using launch templates with Amazon EKS, see Launch\u003cbr/\u003etemplate support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe remote access configuration to use with your node group. For Linux, the\u003cbr/\u003eprotocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate,\u003cbr/\u003ethen don\u0026rsquo;t specify remoteAccess, or the node group deployment will fail.\u003cbr/\u003eFor more information about using launch templates with Amazon EKS, see Launch\u003cbr/\u003etemplate support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.ec2SshKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SourceSecurityGroups\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **remoteAccess.sourceSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eremoteAccess.sourceSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eremoteAccess.sourceSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003escalingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe scaling configuration details for the Auto Scaling group that is created\u003cbr/\u003efor your node group. |\n| \u003cstrong\u003escalingConfig.desiredSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003escalingConfig.maxSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003escalingConfig.minSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe subnets to use for the Auto Scaling group that is created for your node\u003cbr/\u003egroup. If you specify launchTemplate, then don\u0026rsquo;t specify SubnetId (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)\u003cbr/\u003ein your launch template, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide. |\n| \u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\n| \u003cstrong\u003etaints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Kubernetes taints to be applied to the nodes in the node group. For more\u003cbr/\u003einformation, see Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). |\n| \u003cstrong\u003etaints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA property that allows a node to repel a Pod. For more information, see Node\ntaints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html)\nin the Amazon EKS User Guide. || \u003cstrong\u003etaints.[].effect\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaints.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaints.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eupdateConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe node group update configuration. |\n| \u003cstrong\u003eupdateConfig.maxUnavailable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eupdateConfig.maxUnavailablePercentage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Kubernetes version to use for your managed nodes. By default, the Kubernetes\u003cbr/\u003eversion of the cluster is used, and this is the only accepted specified value.\u003cbr/\u003eIf you specify launchTemplate, and your launch template uses a custom AMI,\u003cbr/\u003ethen don\u0026rsquo;t specify version, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nmodifiedAt: string\nresources: \n autoScalingGroups:\n - name: string\n remoteAccessSecurityGroup: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe health status of the node group. If there are issues with your node group\u0026rsquo;s\u003cbr/\u003ehealth, they are listed here.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing an issue with an Amazon EKS resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe resources associated with the node group, such as Auto Scaling groups\u003cbr/\u003eand security groups for remote access.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.autoScalingGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.autoScalingGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Auto Scaling group that is associated with an Amazon EKS managed node\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.remoteAccessSecurityGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the managed node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:135,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/notebookinstance/",title:"NotebookInstance",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#NotebookInstance"\u003esagemaker-controller/apis/v1alpha1#NotebookInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceleratorTypes:\n- string\nadditionalCodeRepositories:\n- string\ndefaultCodeRepository: string\ndirectInternetAccess: string\ninstanceType: string\nkmsKeyID: string\nlifecycleConfigName: string\nnotebookInstanceName: string\nplatformIdentifier: string\nroleARN: string\nrootAccess: string\nsecurityGroupIDs:\n- string\nsubnetID: string\ntags:\n- key: string\n value: string\nvolumeSizeInGB: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceleratorTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Elastic Inference (EI) instance types to associate with this notebook\u003cbr/\u003einstance. Currently, only one instance type can be associated with a notebook\u003cbr/\u003einstance. For more information, see Using Elastic Inference in Amazon SageMaker\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceleratorTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalCodeRepositories.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edirectInternetAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSets whether SageMaker provides internet access to the notebook instance.\u003cbr/\u003eIf you set this to Disabled this notebook instance is able to access resources\u003cbr/\u003eonly in your VPC, and is not be able to connect to SageMaker training and\u003cbr/\u003eendpoint services unless you configure a NAT Gateway in your VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Notebook Instances Are Internet-Enabled by Default\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access).\u003cbr/\u003eYou can set the value of this parameter to Disabled only if you set a value\u003cbr/\u003efor the SubnetId parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of ML compute instance to launch for the notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service\u003cbr/\u003ekey that SageMaker uses to encrypt data on the storage volume attached to\u003cbr/\u003eyour notebook instance. The KMS key you provide must be enabled. For information,\u003cbr/\u003esee Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)\u003cbr/\u003ein the Amazon Web Services Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecycleConfigName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of a lifecycle configuration to associate with the notebook instance.\u003cbr/\u003eFor information about lifestyle configurations, see Step 2.1: (Optional)\u003cbr/\u003eCustomize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform identifier of the notebook instance runtime environment.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you send any requests to Amazon Web Services resources from the notebook\u003cbr/\u003einstance, SageMaker assumes this role to perform tasks on your behalf. You\u003cbr/\u003emust grant this role necessary permissions so SageMaker can perform these\u003cbr/\u003etasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com)\u003cbr/\u003epermissions to assume this role. For more information, see SageMaker Roles\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether root access is enabled or disabled for users of the notebook instance.\u003cbr/\u003eThe default value is Enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLifecycle configurations need root access to be able to set up a notebook\u003cbr/\u003einstance. Because of this, lifecycle configurations associated with a notebook\u003cbr/\u003einstance always run with root access even if you disable root access for\u003cbr/\u003eusers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe VPC security group IDs, in the form sg-xxxxxxxx. The security groups\u003cbr/\u003emust be for the same VPC as specified in the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe size, in GB, of the ML storage volume to attach to the notebook instance.\u003cbr/\u003eThe default value is 5 GB. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nnotebookInstanceStatus: string\nstoppedByControllerMetadata: string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf status is Failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppedByControllerMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL that you use to connect to the Jupyter notebook that is running in\u003cbr/\u003eyour notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eurl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL that you use to connect to the Jupyter notebook that is running in\u003cbr/\u003eyour notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:136,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/",title:"NotebookInstanceLifecycleConfig",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#NotebookInstanceLifecycleConfig"\u003esagemaker-controller/apis/v1alpha1#NotebookInstanceLifecycleConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceLifecycleConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceLifecycleConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstancelifecycleconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstancelifecycleconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003enotebookInstanceLifecycleConfigName: string\nonCreate:\n- content: string\nonStart:\n- content: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceLifecycleConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the lifecycle configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonCreate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA shell script that runs only once, when you create a notebook instance.\u003cbr/\u003eThe shell script must be a base64-encoded string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonCreate.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the notebook instance lifecycle configuration script.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eEach lifecycle configuration script has a limit of 16384 characters.\u003c/p\u003e\n\u003cp\u003eThe value of the $PATH environment variable that is available to both scripts\nis /sbin:bin:/usr/sbin:/usr/bin.\u003c/p\u003e\n\u003cp\u003eView Amazon CloudWatch Logs for notebook instance lifecycle configurations\nin log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].\u003c/p\u003e\n\u003cp\u003eLifecycle configuration scripts cannot run for longer than 5 minutes. If\na script runs for longer than 5 minutes, it fails and the notebook instance\nis not created or started.\u003c/p\u003e\n\u003cp\u003eFor information about notebook instance lifestyle configurations, see Step\n2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). || \u003cstrong\u003eonCreate.[].content\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eonStart\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA shell script that runs every time you start a notebook instance, including\u003cbr/\u003ewhen you create the notebook instance. The shell script must be a base64-encoded\u003cbr/\u003estring. |\n| \u003cstrong\u003eonStart.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the notebook instance lifecycle configuration script.\u003c/p\u003e\n\u003cp\u003eEach lifecycle configuration script has a limit of 16384 characters.\u003c/p\u003e\n\u003cp\u003eThe value of the $PATH environment variable that is available to both scripts\nis /sbin:bin:/usr/sbin:/usr/bin.\u003c/p\u003e\n\u003cp\u003eView Amazon CloudWatch Logs for notebook instance lifecycle configurations\nin log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].\u003c/p\u003e\n\u003cp\u003eLifecycle configuration scripts cannot run for longer than 5 minutes. If\na script runs for longer than 5 minutes, it fails and the notebook instance\nis not created or started.\u003c/p\u003e\n\u003cp\u003eFor information about notebook instance lifestyle configurations, see Step\n2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). || \u003cstrong\u003eonStart.[].content\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that tells when the lifecycle configuration was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that tells when the lifecycle configuration was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:137,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/openidconnectprovider/",title:"OpenIDConnectProvider",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#OpenIDConnectProvider"\u003eiam-controller/apis/v1alpha1#OpenIDConnectProvider\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOpenIDConnectProvider\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOpenIDConnectProviderList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eopenidconnectproviders\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eopenidconnectprovider\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientIDs:\n- string\ntags:\n- key: string\n value: string\nthumbprints:\n- string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of client IDs, also known as audiences. When a mobile or\u003cbr/\u003eweb app registers with an OpenID Connect provider, they establish a value\u003cbr/\u003ethat identifies the application. This is the value that\u0026rsquo;s sent as the client_id\u003cbr/\u003eparameter on OAuth requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can register multiple client IDs with the same provider. For example,\u003cbr/\u003eyou might have multiple applications that use the same OIDC provider. You\u003cbr/\u003ecannot register more than 100 client IDs with a single IAM OIDC provider.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is no defined format for a client ID. The CreateOpenIDConnectProviderRequest\u003cbr/\u003eoperation accepts client IDs up to 255 characters long.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ethumbprints\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of server certificate thumbprints for the OpenID Connect (OIDC) identity\u003cbr/\u003eprovider\u0026rsquo;s server certificates. Typically this list includes only one entry.\u003cbr/\u003eHowever, IAM lets you have up to five thumbprints for an OIDC provider. This\u003cbr/\u003elets you maintain multiple thumbprints if the identity provider is rotating\u003cbr/\u003ecertificates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe server certificate thumbprint is the hex-encoded SHA-1 hash value of\u003cbr/\u003ethe X.509 certificate used by the domain where the OpenID Connect provider\u003cbr/\u003emakes its keys available. It is always a 40-character string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide at least one thumbprint when creating an IAM OIDC provider.\u003cbr/\u003eFor example, assume that the OIDC provider is server.example.com and the\u003cbr/\u003eprovider stores its keys at https://keys.server.example.com/openid-connect.\u003cbr/\u003eIn that case, the thumbprint string would be the hex-encoded SHA-1 hash value\u003cbr/\u003eof the certificate used by https://keys.server.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about obtaining the OIDC provider thumbprint, see Obtaining\u003cbr/\u003ethe thumbprint for an OpenID Connect provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html)\u003cbr/\u003ein the IAM user Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ethumbprints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:138,href:"https://aws-controllers-k8s.github.io/community/reference/organizations/v1alpha1/organizationalunit/",title:"OrganizationalUnit",description:null,content:'\u003cp\u003e\u003ccode\u003eorganizations.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/organizations-controller/apis/v1alpha1#OrganizationalUnit"\u003eorganizations-controller/apis/v1alpha1#OrganizationalUnit\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOrganizationalUnit\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOrganizationalUnitList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eorganizationalunits\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eorganizationalunit\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains details about an organizational unit (OU). An OU is a container\nof Amazon Web Services accounts within a root of an organization. Policies\nthat are attached to an OU apply to all accounts contained in that OU and\nin any child OUs.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nparentID: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe friendly name to assign to the new OU.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparentID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier (ID) of the parent root or OU that you want to create\u003cbr/\u003ethe new OU in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) for a parent ID string\u003cbr/\u003erequires one of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Root - A string that begins with \u0026ldquo;r-\u0026rdquo; followed by from 4 to 32 lowercase\u003cbr/\u003e letters or digits.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Organizational unit (OU) - A string that begins with \u0026ldquo;ou-\u0026rdquo; followed\u003cbr/\u003e by from 4 to 32 lowercase letters or digits (the ID of the root that the\u003cbr/\u003e OU is in). This string is followed by a second \u0026ldquo;-\u0026rdquo; dash and from 8 to\u003cbr/\u003e 32 additional lowercase letters or digits.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the newly created OU. For each\u003cbr/\u003etag in the list, you must specify both a tag key and a value. You can set\u003cbr/\u003ethe value to an empty string, but you can\u0026rsquo;t set it to null. For more information\u003cbr/\u003eabout tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html)\u003cbr/\u003ein the Organizations User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed number of\u003cbr/\u003etags for an OU, then the entire request fails and the OU is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource within your organization.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can attach tags to any of the following organization resources.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eAmazon Web Services account\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eOrganizational unit (OU)\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eOrganization root\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003ePolicy || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier (ID) associated with this OU.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) for an organizational\u003cbr/\u003eunit ID string requires \u0026ldquo;ou-\u0026rdquo; followed by from 4 to 32 lowercase letters\u003cbr/\u003eor digits (the ID of the root that contains the OU). This string is followed\u003cbr/\u003eby a second \u0026ldquo;-\u0026rdquo; dash and from 8 to 32 additional lowercase letters or digits.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:139,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/originrequestpolicy/",title:"OriginRequestPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#OriginRequestPolicy"\u003ecloudfront-controller/apis/v1alpha1#OriginRequestPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOriginRequestPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOriginRequestPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eoriginrequestpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eoriginrequestpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn origin request policy.\u003c/p\u003e\n\u003cp\u003eWhen it\u0026rsquo;s attached to a cache behavior, the origin request policy determines\nthe values that CloudFront includes in requests that it sends to the origin.\nEach request that CloudFront sends to the origin includes the following:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe request body and the URL path (without the domain name) from the\nviewer request.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe headers that CloudFront automatically includes in every origin request,\nincluding Host, User-Agent, and X-Amz-Cf-Id.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAll HTTP headers, cookies, and URL query strings that are specified\nin the cache policy or the origin request policy. These can include items\nfrom the viewer request and, in the case of headers, additional ones that\nare added by CloudFront.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eCloudFront sends a request when it can\u0026rsquo;t find an object in its cache that\nmatches the request. If you want to send values to the origin and also include\nthem in the cache key, use CachePolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eoriginRequestPolicyConfig: \n comment: string\n cookiesConfig: \n cookieBehavior: string\n cookies: \n items:\n - string\n headersConfig: \n headerBehavior: string\n headers: \n items:\n - string\n name: string\n queryStringsConfig: \n queryStringBehavior: string\n queryStrings: \n items:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin request policy configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any cookies in viewer requests (and if\u003cbr/\u003eso, which cookies) are included in requests that CloudFront sends to the\u003cbr/\u003eorigin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookieBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headerBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any URL query strings in viewer requests\u003cbr/\u003e(and if so, which query strings) are included in requests that CloudFront\u003cbr/\u003esends to the origin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStringBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of query string names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the origin request policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the origin request policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:140,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/parametergroup/",title:"ParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#ParameterGroup"\u003ememorydb-controller/apis/v1alpha1#ParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterNameValues:\n- parameterName: string\n parameterValue: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional description of the parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group family that the parameter group can be used with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a name-value pair that is used to update the value of a parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameters:\n- allowedValues: string\n dataType: string\n description: string\n minimumEngineVersion: string\n name: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an individual setting that controls some aspect of MemoryDB behavior.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:141,href:"https://aws-controllers-k8s.github.io/community/reference/pipes/v1alpha1/pipe/",title:"Pipe",description:null,content:'\u003cp\u003e\u003ccode\u003epipes.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/pipes-controller/apis/v1alpha1#Pipe"\u003epipes-controller/apis/v1alpha1#Pipe\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipe\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipeList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipes\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipe\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object that represents a pipe. Amazon EventBridgePipes connect event sources\nto targets and reduces the need for specialized knowledge and integration\ncode.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\ndesiredState: string\nenrichment: string\nenrichmentParameters: \n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n inputTemplate: string\nname: string\nroleARN: string\nsource: string\nsourceParameters: \n activeMQBrokerParameters: \n batchSize: integer\n credentials: \n basicAuth: string\n maximumBatchingWindowInSeconds: integer\n queueName: string\n dynamoDBStreamParameters: \n batchSize: integer\n deadLetterConfig: \n arn: string\n maximumBatchingWindowInSeconds: integer\n maximumRecordAgeInSeconds: integer\n maximumRetryAttempts: integer\n onPartialBatchItemFailure: string\n parallelizationFactor: integer\n startingPosition: string\n filterCriteria: \n filters:\n - pattern: string\n kinesisStreamParameters: \n batchSize: integer\n deadLetterConfig: \n arn: string\n maximumBatchingWindowInSeconds: integer\n maximumRecordAgeInSeconds: integer\n maximumRetryAttempts: integer\n onPartialBatchItemFailure: string\n parallelizationFactor: integer\n startingPosition: string\n startingPositionTimestamp: string\n managedStreamingKafkaParameters: \n batchSize: integer\n consumerGroupID: string\n credentials: \n clientCertificateTLSAuth: string\n saslSCRAM512Auth: string\n maximumBatchingWindowInSeconds: integer\n startingPosition: string\n topicName: string\n rabbitMQBrokerParameters: \n batchSize: integer\n credentials: \n basicAuth: string\n maximumBatchingWindowInSeconds: integer\n queueName: string\n virtualHost: string\n selfManagedKafkaParameters: \n additionalBootstrapServers:\n - string\n batchSize: integer\n consumerGroupID: string\n credentials: \n basicAuth: string\n clientCertificateTLSAuth: string\n saslSCRAM256Auth: string\n saslSCRAM512Auth: string\n maximumBatchingWindowInSeconds: integer\n serverRootCaCertificate: string\n startingPosition: string\n topicName: string\n vpc: \n securityGroup:\n - string\n subnets:\n - string\n sqsQueueParameters: \n batchSize: integer\n maximumBatchingWindowInSeconds: integer\ntags: {}\ntarget: string\ntargetParameters: \n batchJobParameters: \n arrayProperties: \n size: integer\n containerOverrides: \n command:\n - string\n environment:\n - name: string\n value: string\n instanceType: string\n resourceRequirements:\n - type_: string\n value: string\n dependsOn:\n - jobID: string\n type_: string\n jobDefinition: string\n jobName: string\n parameters: {}\n retryStrategy: \n attempts: integer\n cloudWatchLogsParameters: \n logStreamName: string\n timestamp: string\n ecsTaskParameters: \n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n enableECSManagedTags: boolean\n enableExecuteCommand: boolean\n group: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n overrides: \n containerOverrides:\n command:\n - string\n cpu: integer\n environment:\n - name: string\n value: string\n environmentFiles:\n - type_: string\n value: string\n memory: integer\n memoryReservation: integer\n name: string\n resourceRequirements:\n - type_: string\n value: string\n cpu: string\n ephemeralStorage: \n sizeInGiB: integer\n executionRoleARN: string\n inferenceAcceleratorOverrides:\n - deviceName: string\n deviceType: string\n memory: string\n taskRoleARN: string\n placementConstraints:\n - expression: string\n type_: string\n placementStrategy:\n - field: string\n type_: string\n platformVersion: string\n propagateTags: string\n referenceID: string\n tags:\n - key: string\n value: string\n taskCount: integer\n taskDefinitionARN: string\n eventBridgeEventBusParameters: \n detailType: string\n endpointID: string\n resources:\n - string\n source: string\n time: string\n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n inputTemplate: string\n kinesisStreamParameters: \n partitionKey: string\n lambdaFunctionParameters: \n invocationType: string\n redshiftDataParameters: \n database: string\n dbUser: string\n secretManagerARN: string\n sqls:\n - string\n statementName: string\n withEvent: boolean\n sageMakerPipelineParameters: \n pipelineParameterList:\n - name: string\n value: string\n sqsQueueParameters: \n messageDeduplicationID: string\n messageGroupID: string\n stepFunctionStateMachineParameters: \n invocationType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edesiredState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state the pipe should be in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the enrichment resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up enrichment on your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway REST\u003cbr/\u003eAPIs or EventBridge ApiDestinations. In the latter case, these are merged\u003cbr/\u003ewith any InvocationParameters specified on the Connection, with any values\u003cbr/\u003efrom the Connection taking precedence.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.headerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.pathParameterValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.pathParameterValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.inputTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the role that allows the pipe to send data to the target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the source resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up a source for your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an Active MQ broker as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your broker credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.queueName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a DynamoDB stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.onPartialBatchItemFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.parallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe collection of event patterns used to filter events. For more information,\u003cbr/\u003esee Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)\u003cbr/\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria.filters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria.filters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFilter events using an event pattern. For more information, see Events and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEvent Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a Kinesis stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.onPartialBatchItemFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.parallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.startingPositionTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an MSK stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your stream credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials.clientCertificateTLSAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials.saslSCRAM512Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.topicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a Rabbit MQ broker as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your broker credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.queueName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.virtualHost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a self-managed Apache Kafka stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.additionalBootstrapServers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.additionalBootstrapServers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your stream credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.clientCertificateTLSAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM256Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM512Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.serverRootCaCertificate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.topicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the stream,\u003cbr/\u003eand whether a public IP address is to be used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.securityGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of SecurityGroupId.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.securityGroup.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.sqsQueueParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.sqsQueueParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of key-value pairs to associate with the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the target resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up a target for your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an Batch job as a target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.arrayProperties\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe array properties for the submitted job, such as the size of the array.\u003cbr/\u003eThe array size can be between 2 and 10,000. If you specify array properties\u003cbr/\u003efor a job, it becomes an array job. This parameter is used only if the target\u003cbr/\u003eis an Batch job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.arrayProperties.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe overrides that are sent to a container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to send to the container. You can add new environment\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003evariables, which are added to the container at launch, or you can override\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe existing environment variables from the Docker image or the task definition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eEnvironment variables cannot start with \u0026ldquo;Batch\u0026rdquo;. This naming convention is\nreserved for variables that Batch sets. || \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.resourceRequirements\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.resourceRequirements.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresources include GPU, MEMORY, and VCPU. || **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eAn object that represents an Batch job dependency. || **targetParameters.batchJobParameters.dependsOn.[].jobID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.jobDefinition**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.jobName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.parameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.retryStrategy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe retry strategy that\u0026rsquo;s associated with a job. For more information, see\u003cbr/\u003eAutomated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html)\u003cbr/\u003ein the Batch User Guide. |\n| **targetParameters.batchJobParameters.retryStrategy.attempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.cloudWatchLogsParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an CloudWatch Logs log stream as a target. |\n| **targetParameters.cloudWatchLogsParameters.logStreamName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.cloudWatchLogsParameters.timestamp**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an Amazon ECS task as a target. |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem\n(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html)\nin the Amazon ECS API Reference. || **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].base**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].capacityProvider**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].weight**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.enableECSManagedTags**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.enableExecuteCommand**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.group**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.launchType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure specifies the network configuration for an Amazon ECS task. |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the task,\u003cbr/\u003eand whether a public IP address is to be used. This structure is relevant\u003cbr/\u003eonly for ECS tasks that use the awsvpc network mode. |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.overrides**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe overrides that are associated with a task. |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe overrides that are sent to a container. An empty container override can\nbe passed in. An example of an empty container override is {\u0026ldquo;containerOverrides\u0026rdquo;:\n[ ] }. If a non-empty container override is specified, the name parameter\nmust be included. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].cpu**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override\nthe existing environment variables from the Docker image or the task definition.\nYou must also specify a container name. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of files containing the environment variables to pass to a container.\nYou can specify up to ten environment files. The file must have a .env file\nextension. Each line in an environment file should contain an environment\nvariable in VARIABLE=VALUE format. Lines beginning with # are treated as\ncomments and are ignored. For more information about the environment variable\nfile syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/).\u003c/p\u003e\n\u003cp\u003eIf there are environment variables specified using the environment parameter\nin a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that\ncontain the same variable, they\u0026rsquo;re processed from the top down. We recommend\nthat you use unique variable names. For more information, see Specifying\nenvironment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eThis parameter is only supported for tasks hosted on Fargate using the following\nplatform versions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.4.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memory**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memoryReservation**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresource types are GPUs and Elastic Inference accelerators. For more information,\nsee Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html)\nor Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.cpu**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.ephemeralStorage**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe amount of ephemeral storage to allocate for the task. This parameter\u003cbr/\u003eis used to expand the total amount of ephemeral storage available, beyond\u003cbr/\u003ethe default amount, for tasks hosted on Fargate. For more information, see\u003cbr/\u003eFargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html)\u003cbr/\u003ein the Amazon ECS User Guide for Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for tasks hosted on Fargate using Linux\u003cbr/\u003eplatform version 1.4.0 or later. This parameter is not supported for Windows\u003cbr/\u003econtainers on Fargate. |\n| **targetParameters.ecsTaskParameters.overrides.ephemeralStorage.sizeInGiB**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.executionRoleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDetails on an Elastic Inference accelerator task override. This parameter\nis used to override the Elastic Inference accelerator specified in the task\ndefinition. For more information, see Working with Amazon Elastic Inference\non Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide. || **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.memory**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.taskRoleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eAn object representing a constraint on task placement. To learn more, see\nTask Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide. || **targetParameters.ecsTaskParameters.placementConstraints.[].expression**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe task placement strategy for a task or service. To learn more, see Task\nPlacement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Service Developer Guide. || **targetParameters.ecsTaskParameters.placementStrategy.[].field**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.platformVersion**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.propagateTags**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.referenceID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\nrules and event buses support tagging. || **targetParameters.ecsTaskParameters.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.taskCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.taskDefinitionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an EventBridge event bus as a target. |\n| **targetParameters.eventBridgeEventBusParameters.detailType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.endpointID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.resources**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.resources.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.eventBridgeEventBusParameters.source**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.time**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.httpParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway REST\u003cbr/\u003eAPIs or EventBridge ApiDestinations. |\n| **targetParameters.httpParameters.headerParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.httpParameters.pathParameterValues**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.httpParameters.pathParameterValues.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.httpParameters.queryStringParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.inputTemplate**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.kinesisStreamParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Kinesis stream as a source. |\n| **targetParameters.kinesisStreamParameters.partitionKey**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.lambdaFunctionParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Lambda function as a target. |\n| **targetParameters.lambdaFunctionParameters.invocationType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.redshiftDataParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to be used when the target is a Amazon Redshift\u003cbr/\u003ecluster to invoke the Amazon Redshift Data API ExecuteStatement. |\n| **targetParameters.redshiftDataParameters.database**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// Redshift Database |\n| **targetParameters.redshiftDataParameters.dbUser**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// Database user name |\n| **targetParameters.redshiftDataParameters.secretManagerARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// For targets, can either specify an ARN or a jsonpath pointing to the ARN. |\n| **targetParameters.redshiftDataParameters.sqls**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e// A list of SQLs. |\n| **targetParameters.redshiftDataParameters.sqls.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.redshiftDataParameters.statementName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// A name for Redshift DataAPI statement which can be used as filter of //\u003cbr/\u003eListStatement. |\n| **targetParameters.redshiftDataParameters.withEvent**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a SageMaker pipeline as a target. |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eName/Value pair of a parameter to start execution of a SageMaker Model Building\nPipeline. || **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sqsQueueParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Amazon SQS stream as a source. |\n| **targetParameters.sqsQueueParameters.messageDeduplicationID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sqsQueueParameters.messageGroupID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.stepFunctionStateMachineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Step Functions state machine as a target. |\n| **targetParameters.stepFunctionStateMachineParameters.invocationType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncurrentState: string\nlastModifiedTime: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time the pipe was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecurrentState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state the pipe is in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the pipe is in its current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:142,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/pipeline/",title:"Pipeline",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Pipeline"\u003esagemaker-controller/apis/v1alpha1#Pipeline\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipeline\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelines\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipeline\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA SageMaker Model Building Pipeline instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eparallelismConfiguration: \n maxParallelExecutionSteps: integer\npipelineDefinition: string\npipelineDescription: string\npipelineDisplayName: string\npipelineName: string\nroleARN: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis is the configuration that controls the parallelism of the pipeline.\u003cbr/\u003eIf specified, it applies to all runs of this pipeline by default.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration.maxParallelExecutionSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON pipeline definition (https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/)\u003cbr/\u003eof the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe display name of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the role used by the pipeline to access\u003cbr/\u003eand create resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to apply to the created pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\npipelineStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:143,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/pipelineexecution/",title:"PipelineExecution",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#PipelineExecution"\u003esagemaker-controller/apis/v1alpha1#PipelineExecution\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineExecution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineExecutionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelineexecutions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelineexecution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn execution of a pipeline.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eparallelismConfiguration: \n maxParallelExecutionSteps: integer\npipelineExecutionDescription: string\npipelineExecutionDisplayName: string\npipelineName: string\npipelineParameters:\n- name: string\n value: string\nselectiveExecutionConfig: \n selectedSteps:\n - stepName: string\n sourcePipelineExecutionARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis configuration, if specified, overrides the parallelism configuration\u003cbr/\u003eof the parent pipeline for this specific run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration.maxParallelExecutionSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe display name of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of pipeline parameters. This list can be empty.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssigns a value to a named Pipeline parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe selective execution configuration applied to the pipeline run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.selectedSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.selectedSteps.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA step selected to run in selective execution mode.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.sourcePipelineExecutionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfailureReason: string\nlastModifiedTime: string\npipelineExecutionStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline execution was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the execution failed, a message describing why.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline execution was modified last.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:144,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/platformapplication/",title:"PlatformApplication",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#PlatformApplication"\u003esns-controller/apis/v1alpha1#PlatformApplication\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformApplication\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformApplicationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformapplications\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformapplication\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003ePlatform application object.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eeventDeliveryFailure: string\neventEndpointCreated: string\neventEndpointCreatedRef: \n from: \n name: string\neventEndpointDeleted: string\neventEndpointDeletedRef: \n from: \n name: string\neventEndpointUpdated: string\neventEndpointUpdatedRef: \n from: \n name: string\nfailureFeedbackRoleARN: string\nfailureFeedbackRoleRef: \n from: \n name: string\nname: string\nplatform: string\nplatformCredential: string\nplatformPrincipal: string\nsuccessFeedbackRoleARN: string\nsuccessFeedbackRoleRef: \n from: \n name: string\nsuccessFeedbackSampleRate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventDeliveryFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeleted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eApplication names must be made up of only uppercase and lowercase ASCII letters,\u003cbr/\u003enumbers, underscores, hyphens, and periods, and must be between 1 and 256\u003cbr/\u003echaracters long.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatform\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe following platforms are supported: ADM (Amazon Device Messaging), APNS\u003cbr/\u003e(Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud\u003cbr/\u003eMessaging).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformCredential\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformPrincipal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackSampleRate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:145,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/platformendpoint/",title:"PlatformEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#PlatformEndpoint"\u003esns-controller/apis/v1alpha1#PlatformEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecustomUserData: string\nenabled: string\nplatformApplicationARN: string\ntoken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomUserData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformApplicationARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ePlatformApplicationArn returned from CreatePlatformApplication is used to\u003cbr/\u003ecreate a an endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etoken\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nendpointARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEndpointArn returned from CreateEndpoint action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:146,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/podidentityassociation/",title:"PodIdentityAssociation",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#PodIdentityAssociation"\u003eeks-controller/apis/v1alpha1#PodIdentityAssociation\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePodIdentityAssociation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePodIdentityAssociationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epodidentityassociations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epodidentityassociation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon EKS Pod Identity associations provide the ability to manage credentials\nfor your applications, similar to the way that Amazon EC2 instance profiles\nprovide credentials to Amazon EC2 instances.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nnamespace: string\nroleARN: string\nroleRef: \n from: \n name: string\nserviceAccount: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster to create the association in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Kubernetes namespace inside the cluster to create the association\u003cbr/\u003ein. The service account and the pods that use the service account must be\u003cbr/\u003ein this namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to associate with the service\u003cbr/\u003eaccount. The EKS Pod Identity agent manages credentials to assume this role\u003cbr/\u003efor applications in the containers in the pods that use this service account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccount\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Kubernetes service account inside the cluster to associate\u003cbr/\u003ethe IAM credentials with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource – 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length – 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length – 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociationARN: string\nassociationID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nmodifiedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociationARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the association.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the association.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that the association was created at.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe most recent timestamp that the association was modified at\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:147,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/policy/",title:"Policy",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Policy"\u003eiam-controller/apis/v1alpha1#Policy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a managed policy.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the CreatePolicy, GetPolicy,\nand ListPolicies operations.\u003c/p\u003e\n\u003cp\u003eFor more information about managed policies, refer to Managed policies and\ninline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)\nin the IAM User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\npath: string\npolicyDocument: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly description of the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypically used to store information about the permissions defined in the\u003cbr/\u003epolicy. For example, \u0026ldquo;Grants access to production DynamoDB tables.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe policy description is immutable. After a value is assigned, it cannot\u003cbr/\u003ebe changed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe friendly name of the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path for the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use an asterisk (*) in the path name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyDocument\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON policy document that you want to use as the content for the new\u003cbr/\u003epolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide policies in JSON format in IAM. However, for CloudFormation\u003cbr/\u003etemplates formatted in YAML, you can provide the policy in JSON or YAML format.\u003cbr/\u003eCloudFormation always converts a YAML policy to JSON format before submitting\u003cbr/\u003eit to IAM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum length of the policy document that you can pass in this operation,\u003cbr/\u003eincluding whitespace, is listed below. To view the maximum character counts\u003cbr/\u003eof a managed policy with no whitespaces, see IAM and STS character quotas\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn more about JSON policy grammar, see Grammar of the IAM JSON policy\u003cbr/\u003elanguage (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) used to validate this\u003cbr/\u003eparameter is a string of characters consisting of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Any printable ASCII character ranging from the space character (\\u0020)\u003cbr/\u003e through the end of the ASCII character range\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The special characters tab (\\u0009), line feed (\\u000A), and carriage\u003cbr/\u003e return (\\u000D)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new IAM customer managed policy.\u003cbr/\u003eEach tag consists of a key name and an associated value. For more information\u003cbr/\u003eabout tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nattachmentCount: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ndefaultVersionID: string\nisAttachable: boolean\npermissionsBoundaryUsageCount: integer\npolicyID: string\nupdateDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachmentCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of entities (users, groups, and roles) that the policy is attached\u003cbr/\u003eto.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultVersionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the version of the policy that is set as the default version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisAttachable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the policy can be attached to an IAM user, group, or role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryUsageCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of entities (users and roles) for which the policy is used to\u003cbr/\u003eset the permissions boundary.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about permissions boundaries, see Permissions boundaries\u003cbr/\u003efor IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the policy was last updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a policy has only one version, this field contains the date and time\u003cbr/\u003ewhen the policy was created. When a policy has more than one version, this\u003cbr/\u003efield contains the date and time when the most recent policy version was\u003cbr/\u003ecreated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:148,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/processingjob/",title:"ProcessingJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ProcessingJob"\u003esagemaker-controller/apis/v1alpha1#ProcessingJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eProcessingJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eProcessingJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eprocessingjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eprocessingjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Amazon SageMaker processing job that is used to analyze data and evaluate\nmodels. For more information, see Process Data and Evaluate Models (https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n imageURI: string\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nprocessingInputs:\n- appManaged: boolean\n datasetDefinition: \n athenaDatasetDefinition: \n catalog: string\n database: string\n kmsKeyID: string\n outputCompression: string\n outputFormat: string\n outputS3URI: string\n queryString: string\n workGroup: string\n dataDistributionType: string\n inputMode: string\n localPath: string\n redshiftDatasetDefinition: \n clusterID: string\n clusterRoleARN: string\n database: string\n dbUser: string\n kmsKeyID: string\n outputCompression: string\n outputFormat: string\n outputS3URI: string\n queryString: string\n inputName: string\n s3Input: \n localPath: string\n s3CompressionType: string\n s3DataDistributionType: string\n s3DataType: string\n s3InputMode: string\n s3URI: string\nprocessingJobName: string\nprocessingOutputConfig: \n kmsKeyID: string\n outputs:\n - appManaged: boolean\n featureStoreOutput: \n featureGroupName: string\n outputName: string\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nprocessingResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the processing job to run a specified Docker container image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container. Up to 100 key and\u003cbr/\u003evalues entries in the map are supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a processing job, such as whether to allow inbound\u003cbr/\u003eand outbound network calls to and from processing containers, and the VPC\u003cbr/\u003esubnets and security groups to use for VPC-enabled processing jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inputs for a processing job. The processing input must specify exactly\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eone of either S3Input or DatasetDefinition types.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Dataset Definition inputs. The Dataset Definition input\u003cbr/\u003emust specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition\u003cbr/\u003etypes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Athena Dataset Definition input.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.catalog\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the data catalog used in Athena query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database used in the Athena query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputCompression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compression used for Athena query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe data storage format for Athena query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.queryString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SQL query statements, to be executed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.workGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the workgroup in which the Athena query is being started.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.dataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.inputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Redshift Dataset Definition input.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.clusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Redshift cluster Identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.clusterRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Redshift database used in Redshift query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.dbUser\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe database user name used in Redshift query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputCompression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compression used for Redshift query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe data storage format for Redshift query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.queryString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SQL query statements to be executed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].inputName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for downloading input data from Amazon S3 into the processing\u003cbr/\u003econtainer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3CompressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingJobName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the processing job. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOutput configuration for the processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of a processing job. The processing output must specify\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eexactly one of either S3Output or FeatureStoreOutput types.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].featureStoreOutput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for processing job outputs in Amazon SageMaker Feature Store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].featureStoreOutput.featureGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].outputName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for uploading output data to Amazon S3 from the processing\u003cbr/\u003econtainer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources, ML compute instances, and ML storage volumes to\u003cbr/\u003edeploy for a processing job. In distributed training, you specify more than\u003cbr/\u003eone instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run a processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume\u003cbr/\u003eto perform tasks on your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe time limit for how long the processing job is allowed to run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nprocessingJobStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string, up to one KB in size, that contains the reason a processing job\u003cbr/\u003efailed, if it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of a processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:149,href:"https://aws-controllers-k8s.github.io/community/reference/ecr/v1alpha1/pullthroughcacherule/",title:"PullThroughCacheRule",description:null,content:'\u003cp\u003e\u003ccode\u003eecr.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecr-controller/apis/v1alpha1#PullThroughCacheRule"\u003eecr-controller/apis/v1alpha1#PullThroughCacheRule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePullThroughCacheRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePullThroughCacheRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epullthroughcacherules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epullthroughcacherule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details of a pull through cache rule.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eecrRepositoryPrefix: string\nregistryID: string\nupstreamRegistryURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eecrRepositoryPrefix\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe repository name prefix to use when caching images from the source registry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregistryID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID associated with the registry to create\u003cbr/\u003ethe pull through cache rule for. If you do not specify a registry, the default\u003cbr/\u003eregistry is assumed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupstreamRegistryURL\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe registry URL of the upstream public registry to use as the source for\u003cbr/\u003ethe pull through cache rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in JavaScript date format, when the pull through cache\u003cbr/\u003erule was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:150,href:"https://aws-controllers-k8s.github.io/community/reference/sqs/v1alpha1/queue/",title:"Queue",description:null,content:'\u003cp\u003e\u003ccode\u003esqs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sqs-controller/apis/v1alpha1#Queue"\u003esqs-controller/apis/v1alpha1#Queue\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eQueue\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eQueueList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003equeues\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003equeue\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtentBasedDeduplication: string\ndelaySeconds: string\nfifoQueue: string\nkmsDataKeyReusePeriodSeconds: string\nkmsMasterKeyID: string\nkmsMasterKeyRef: \n from: \n name: string\nmaximumMessageSize: string\nmessageRetentionPeriod: string\npolicy: string\npolicyRef: \n from: \n name: string\nqueueName: string\nreceiveMessageWaitTimeSeconds: string\nredriveAllowPolicy: string\nredrivePolicy: string\ntags: {}\nvisibilityTimeout: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentBasedDeduplication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edelaySeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efifoQueue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsDataKeyReusePeriodSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumMessageSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emessageRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereceiveMessageWaitTimeSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredriveAllowPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredrivePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdd cost allocation tags to the specified Amazon SQS queue. For an overview,\u003cbr/\u003esee Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you use queue tags, keep the following guidelines in mind:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Adding more than 50 tags to a queue isn\u0026rsquo;t recommended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tags don\u0026rsquo;t have any semantic meaning. Amazon SQS interprets tags as\u003cbr/\u003e character strings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tags are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A new tag with a key identical to that of an existing tag overwrites\u003cbr/\u003e the existing tag.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to tag a queue on creation, you must have the sqs:CreateQueue\u003cbr/\u003eand sqs:TagQueue permissions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCross-account permissions don\u0026rsquo;t apply to this action. For more information,\u003cbr/\u003esee Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evisibilityTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nqueueARN: string\nqueueURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL of the created Amazon SQS queue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:151,href:"https://aws-controllers-k8s.github.io/community/reference/route53/v1alpha1/recordset/",title:"RecordSet",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53-controller/apis/v1alpha1#RecordSet"\u003eroute53-controller/apis/v1alpha1#RecordSet\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRecordSet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRecordSetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erecordsets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erecordset\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealiasTarget: \n dnsName: string\n evaluateTargetHealth: boolean\n hostedZoneID: string\nchangeBatch: \n changes:\n - action: string\n resourceRecordSet: \n aliasTarget: \n dnsName: string\n evaluateTargetHealth: boolean\n hostedZoneID: string\n cidrRoutingConfig: \n collectionID: string\n locationName: string\n failover: string\n geoLocation: \n continentCode: string\n countryCode: string\n subdivisionCode: string\n healthCheckID: string\n multiValueAnswer: boolean\n name: string\n region: string\n resourceRecords:\n - value: string\n setIdentifier: string\n trafficPolicyInstanceID: string\n ttl: integer\n type_: string\n weight: integer\n comment: string\ncidrRoutingConfig: \n collectionID: string\n locationName: string\nfailover: string\ngeoLocation: \n continentCode: string\n countryCode: string\n subdivisionCode: string\nhealthCheckID: string\nhostedZoneID: string\nhostedZoneRef: \n from: \n name: string\nmultiValueAnswer: boolean\nname: string\nrecordType: string\nregion: string\nresourceRecords:\n- value: string\nsetIdentifier: string\nttl: integer\nweight: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlias resource record sets only: Information about the Amazon Web Services\u003cbr/\u003eresource, such as a CloudFront distribution or an Amazon S3 bucket, that\u003cbr/\u003eyou want to route traffic to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating resource records sets for a private hosted zone, note\u003cbr/\u003ethe following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create an alias resource record set in a private hosted zone\u003cbr/\u003e to route traffic to a CloudFront distribution.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For information about creating failover resource record sets in a private\u003cbr/\u003e hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\u003cbr/\u003e in the Amazon Route 53 Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.evaluateTargetHealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains an optional comment and the Changes element.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information for each resource record set that you want to change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the resource record set to create or delete.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlias resource record sets only: Information about the Amazon Web Services\u003cbr/\u003eresource, such as a CloudFront distribution or an Amazon S3 bucket, that\u003cbr/\u003eyou want to route traffic to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen creating resource record sets for a private hosted zone, note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For information about creating failover resource record sets in a private\u003cbr/\u003e hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.evaluateTargetHealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe object that is specified in resource record set object when you are linking\u003cbr/\u003ea resource record set to a CIDR location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA LocationName with an asterisk “*” can be used to create a default CIDR\u003cbr/\u003erecord. CollectionId is still required for default record.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig.collectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig.locationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.failover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about a geographic location.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.continentCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.countryCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.subdivisionCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.healthCheckID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.multiValueAnswer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation specific to the resource record.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecord. || \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.setIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.trafficPolicyInstanceID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.ttl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| **changeBatch.changes.[].resourceRecordSet.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **changeBatch.changes.[].resourceRecordSet.weight**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **changeBatch.comment**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **cidrRoutingConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe object that is specified in resource record set object when you are linking\u003cbr/\u003ea resource record set to a CIDR location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA LocationName with an asterisk “*” can be used to create a default CIDR\u003cbr/\u003erecord. CollectionId is still required for default record. |\n| **cidrRoutingConfig.collectionID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **cidrRoutingConfig.locationName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **failover**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eFailover resource record sets only: To configure failover, you add the Failover\u003cbr/\u003eelement to two resource record sets. For one resource record set, you specify\u003cbr/\u003ePRIMARY as the value for Failover; for the other resource record set, you\u003cbr/\u003especify SECONDARY. In addition, you include the HealthCheckId element and\u003cbr/\u003especify the health check that you want Amazon Route 53 to perform for each\u003cbr/\u003eresource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExcept where noted, the following failover behaviors assume that you have\u003cbr/\u003eincluded the HealthCheckId element in both resource record sets:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the primary resource record set is healthy, Route 53 responds to\u003cbr/\u003e DNS queries with the applicable value from the primary resource record\u003cbr/\u003e set regardless of the health of the secondary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the primary resource record set is unhealthy and the secondary\u003cbr/\u003e resource record set is healthy, Route 53 responds to DNS queries with\u003cbr/\u003e the applicable value from the secondary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the secondary resource record set is unhealthy, Route 53 responds\u003cbr/\u003e to DNS queries with the applicable value from the primary resource record\u003cbr/\u003e set regardless of the health of the primary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you omit the HealthCheckId element for the secondary resource record\u003cbr/\u003e set, and if the primary resource record set is unhealthy, Route 53 always\u003cbr/\u003e responds to DNS queries with the applicable value from the secondary resource\u003cbr/\u003e record set. This is true regardless of the health of the associated endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create non-failover resource record sets that have the same values\u003cbr/\u003efor the Name and Type elements as failover resource record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor failover alias resource record sets, you must also include the EvaluateTargetHealth\u003cbr/\u003eelement and set the value to true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about configuring failover for Route 53, see the following\u003cbr/\u003etopics in the Amazon Route 53 Developer Guide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) |\n| **geoLocation**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eGeolocation resource record sets only: A complex type that lets you control\u003cbr/\u003ehow Amazon Route 53 responds to DNS queries based on the geographic origin\u003cbr/\u003eof the query. For example, if you want all queries from Africa to be routed\u003cbr/\u003eto a web server with an IP address of 192.0.2.111, create a resource record\u003cbr/\u003eset with a Type of A and a ContinentCode of AF.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlthough creating geolocation and geolocation alias resource record sets\u003cbr/\u003ein a private hosted zone is allowed, it\u0026rsquo;s not supported.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create separate resource record sets for overlapping geographic regions\u003cbr/\u003e(for example, one resource record set for a continent and one for a country\u003cbr/\u003eon the same continent), priority goes to the smallest geographic region.\u003cbr/\u003eThis allows you to route most queries for a continent to one resource and\u003cbr/\u003eto route queries for a country on that continent to a different resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create two geolocation resource record sets that specify the same\u003cbr/\u003egeographic location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value * in the CountryCode element matches all geographic locations that\u003cbr/\u003earen\u0026rsquo;t specified in other geolocation resource record sets that have the\u003cbr/\u003esame values for the Name and Type elements.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eGeolocation works by mapping IP addresses to locations. However, some IP\u003cbr/\u003eaddresses aren\u0026rsquo;t mapped to geographic locations, so even if you create geolocation\u003cbr/\u003eresource record sets that cover all seven continents, Route 53 will receive\u003cbr/\u003esome DNS queries from locations that it can\u0026rsquo;t identify. We recommend that\u003cbr/\u003eyou create a resource record set for which the value of CountryCode is *.\u003cbr/\u003eTwo groups of queries are routed to the resource that you specify in this\u003cbr/\u003erecord: queries that come from locations for which you haven\u0026rsquo;t created geolocation\u003cbr/\u003eresource record sets and queries from IP addresses that aren\u0026rsquo;t mapped to\u003cbr/\u003ea location. If you don\u0026rsquo;t create a * resource record set, Route 53 returns\u003cbr/\u003ea \u0026ldquo;no answer\u0026rdquo; response for queries from those locations.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create non-geolocation resource record sets that have the same\u003cbr/\u003evalues for the Name and Type elements as geolocation resource record sets. |\n| **geoLocation.continentCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **geoLocation.countryCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **geoLocation.subdivisionCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **healthCheckID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eIf you want Amazon Route 53 to return this resource record set in response\u003cbr/\u003eto a DNS query only when the status of a health check is healthy, include\u003cbr/\u003ethe HealthCheckId element and specify the ID of the applicable health check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRoute 53 determines whether a resource record set is healthy based on one\u003cbr/\u003eof the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By periodically sending a request to the endpoint that is specified\u003cbr/\u003e in the health check\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By aggregating the status of a specified group of health checks (calculated\u003cbr/\u003e health checks)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By determining the current state of a CloudWatch alarm (CloudWatch metric\u003cbr/\u003e health checks)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRoute 53 doesn\u0026rsquo;t check the health of the endpoint that is specified in the\u003cbr/\u003eresource record set, for example, the endpoint specified by the IP address\u003cbr/\u003ein the Value element. When you add a HealthCheckId element to a resource\u003cbr/\u003erecord set, Route 53 checks the health of the endpoint that you specified\u003cbr/\u003ein the health check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see the following topics in the Amazon Route 53 Developer\u003cbr/\u003eGuide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * How Amazon Route 53 Determines Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen to Specify HealthCheckId\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecifying a value for HealthCheckId is useful only when Route 53 is choosing\u003cbr/\u003ebetween two or more resource record sets to respond to a DNS query, and you\u003cbr/\u003ewant Route 53 to base the choice in part on the status of a health check.\u003cbr/\u003eConfiguring health checks makes sense only in the following configurations:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Non-alias resource record sets: You\u0026rsquo;re checking the health of a group\u003cbr/\u003e of non-alias resource record sets that have the same routing policy, name,\u003cbr/\u003e and type (such as multiple weighted records named www.example.com with\u003cbr/\u003e a type of A) and you specify health check IDs for all the resource record\u003cbr/\u003e sets. If the health check status for a resource record set is healthy,\u003cbr/\u003e Route 53 includes the record among the records that it responds to DNS\u003cbr/\u003e queries with. If the health check status for a resource record set is\u003cbr/\u003e unhealthy, Route 53 stops responding to DNS queries using the value for\u003cbr/\u003e that resource record set. If the health check status for all resource\u003cbr/\u003e record sets in the group is unhealthy, Route 53 considers all resource\u003cbr/\u003e record sets in the group healthy and responds to DNS queries accordingly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias resource record sets: You specify the following settings: You\u003cbr/\u003e set EvaluateTargetHealth to true for an alias resource record set in a\u003cbr/\u003e group of resource record sets that have the same routing policy, name,\u003cbr/\u003e and type (such as multiple weighted records named www.example.com with\u003cbr/\u003e a type of A). You configure the alias resource record set to route traffic\u003cbr/\u003e to a non-alias resource record set in the same hosted zone. You specify\u003cbr/\u003e a health check ID for the non-alias resource record set. If the health\u003cbr/\u003e check status is healthy, Route 53 considers the alias resource record\u003cbr/\u003e set to be healthy and includes the alias record among the records that\u003cbr/\u003e it responds to DNS queries with. If the health check status is unhealthy,\u003cbr/\u003e Route 53 stops responding to DNS queries using the alias resource record\u003cbr/\u003e set. The alias resource record set can also route traffic to a group of\u003cbr/\u003e non-alias resource record sets that have the same routing policy, name,\u003cbr/\u003e and type. In that configuration, associate health checks with all of the\u003cbr/\u003e resource record sets in the group of non-alias resource record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eGeolocation Routing\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor geolocation resource record sets, if an endpoint is unhealthy, Route\u003cbr/\u003e53 looks for a resource record set for the larger, associated geographic\u003cbr/\u003eregion. For example, suppose you have resource record sets for a state in\u003cbr/\u003ethe United States, for the entire United States, for North America, and a\u003cbr/\u003eresource record set that has * for CountryCode is *, which applies to all\u003cbr/\u003elocations. If the endpoint for the state resource record set is unhealthy,\u003cbr/\u003eRoute 53 checks for healthy resource record sets in the following order until\u003cbr/\u003eit finds a resource record set for which the endpoint is healthy:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The United States\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * North America\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The default resource record set\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecifying the Health Check Endpoint by Domain Name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your health checks specify the endpoint only by domain name, we recommend\u003cbr/\u003ethat you create a separate health check for each endpoint. For example, create\u003cbr/\u003ea health check for each HTTP server that is serving content for www.example.com.\u003cbr/\u003eFor the value of FullyQualifiedDomainName, specify the domain name of the\u003cbr/\u003eserver (such as us-east-2-www.example.com), not the name of the resource\u003cbr/\u003erecord sets (www.example.com).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eHealth check results will be unpredictable if you do the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Create a health check that has the same value for FullyQualifiedDomainName\u003cbr/\u003e as the name of a resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Associate that health check with the resource record set. |\n| **hostedZoneID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe ID of the hosted zone that contains the resource record sets that you\u003cbr/\u003ewant to change. |\n| **hostedZoneRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **hostedZoneRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **hostedZoneRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **multiValueAnswer**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003eMultivalue answer resource record sets only: To route traffic approximately\u003cbr/\u003erandomly to multiple resources, such as web servers, create one multivalue\u003cbr/\u003eanswer record for each resource and specify true for MultiValueAnswer. Note\u003cbr/\u003ethe following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you associate a health check with a multivalue answer resource record\u003cbr/\u003e set, Amazon Route 53 responds to DNS queries with the corresponding IP\u003cbr/\u003e address only when the health check is healthy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you don\u0026rsquo;t associate a health check with a multivalue answer record,\u003cbr/\u003e Route 53 always considers the record to be healthy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 responds to DNS queries with up to eight healthy records; if\u003cbr/\u003e you have eight or fewer healthy records, Route 53 responds to all DNS\u003cbr/\u003e queries with all the healthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you have more than eight healthy records, Route 53 responds to different\u003cbr/\u003e DNS resolvers with different combinations of healthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When all records are unhealthy, Route 53 responds to DNS queries with\u003cbr/\u003e up to eight unhealthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If a resource becomes unavailable after a resolver caches a response,\u003cbr/\u003e client software typically tries another of the IP addresses in the response.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create multivalue answer alias records. |\n| **name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eFor ChangeResourceRecordSets requests, the name of the record that you want\u003cbr/\u003eto create, update, or delete. For ListResourceRecordSets responses, the name\u003cbr/\u003eof a record in the specified hosted zone.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eChangeResourceRecordSets Only\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEnter a fully qualified domain name, for example, www.example.com. You can\u003cbr/\u003eoptionally include a trailing dot. If you omit the trailing dot, Amazon Route\u003cbr/\u003e53 assumes that the domain name that you specify is fully qualified. This\u003cbr/\u003emeans that Route 53 treats www.example.com (without a trailing dot) and www.example.com.\u003cbr/\u003e(with a trailing dot) as identical.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about how to specify characters other than a-z, 0-9, and\u003cbr/\u003e- (hyphen) and how to specify internationalized domain names, see DNS Domain\u003cbr/\u003eName Format (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the asterisk (*) wildcard to replace the leftmost label in a\u003cbr/\u003edomain name, for example, *.example.com. Note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The * must replace the entire label. For example, you can\u0026rsquo;t specify\u003cbr/\u003e *prod.example.com or prod*.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The * can\u0026rsquo;t replace any of the middle labels, for example, marketing.*.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you include * in any position other than the leftmost label in a\u003cbr/\u003e domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\u003cbr/\u003e You can\u0026rsquo;t use the * wildcard for resource records sets that have a type\u003cbr/\u003e of NS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the * wildcard as the leftmost label in a domain name, for example,\u003cbr/\u003e*.example.com. You can\u0026rsquo;t use an * for one of the middle labels, for example,\u003cbr/\u003emarketing.*.example.com. In addition, the * must replace the entire label;\u003cbr/\u003efor example, you can\u0026rsquo;t specify prod*.example.com. |\n| **recordType**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe DNS record type. For information about different record types and how\u003cbr/\u003edata is encoded for them, see Supported DNS Resource Record Types (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for basic resource record sets: A | AAAA | CAA | CNAME | DS\u003cbr/\u003e|MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValues for weighted, latency, geolocation, and failover resource record sets:\u003cbr/\u003eA | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating\u003cbr/\u003ea group of weighted, latency, geolocation, or failover resource record sets,\u003cbr/\u003especify the same value for all of the resource record sets in the group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for multivalue answer resource record sets: A | AAAA | MX |\u003cbr/\u003eNAPTR | PTR | SPF | SRV | TXT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSPF records were formerly used to verify the identity of the sender of email\u003cbr/\u003emessages. However, we no longer recommend that you create resource record\u003cbr/\u003esets for which the value of Type is SPF. RFC 7208, Sender Policy Framework\u003cbr/\u003e(SPF) for Authorizing Use of Domains in Email, Version 1, has been updated\u003cbr/\u003eto say, \u0026ldquo;\u0026hellip;[I]ts existence and mechanism defined in [RFC4408] have led to\u003cbr/\u003esome interoperability issues. Accordingly, its use is no longer appropriate\u003cbr/\u003efor SPF version 1; implementations are not to use it.\u0026rdquo; In RFC 7208, see section\u003cbr/\u003e14.1, The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValues for alias resource record sets:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon API Gateway custom regional APIs and edge-optimized APIs: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront distributions: A If IPv6 is enabled for the distribution,\u003cbr/\u003e create two resource record sets to route traffic to your distribution,\u003cbr/\u003e one with a value of A and one with a value of AAAA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon API Gateway environment that has a regionalized subdomain: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ELB load balancers: A | AAAA\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon S3 buckets: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Virtual Private Cloud interface VPC endpoints A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Another resource record set in this hosted zone: Specify the type of\u003cbr/\u003e the resource record set that you\u0026rsquo;re creating the alias for. All values\u003cbr/\u003e are supported except NS and SOA. If you\u0026rsquo;re creating an alias record that\u003cbr/\u003e has the same name as the hosted zone (known as the zone apex), you can\u0026rsquo;t\u003cbr/\u003e route traffic to a record for which the value of Type is CNAME. This is\u003cbr/\u003e because the alias record must have the same type as the record you\u0026rsquo;re\u003cbr/\u003e routing traffic to, and creating a CNAME record for the zone apex isn\u0026rsquo;t\u003cbr/\u003e supported even for an alias record. |\n| **region**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eLatency-based resource record sets only: The Amazon EC2 Region where you\u003cbr/\u003ecreated the resource that this resource record set refers to. The resource\u003cbr/\u003etypically is an Amazon Web Services resource, such as an EC2 instance or\u003cbr/\u003ean ELB load balancer, and is referred to by an IP address or a DNS domain\u003cbr/\u003ename, depending on the record type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen Amazon Route 53 receives a DNS query for a domain name and type for\u003cbr/\u003ewhich you have created latency resource record sets, Route 53 selects the\u003cbr/\u003elatency resource record set that has the lowest latency between the end user\u003cbr/\u003eand the associated Amazon EC2 Region. Route 53 then returns the value that\u003cbr/\u003eis associated with the selected resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only specify one ResourceRecord per latency resource record\u003cbr/\u003e set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only create one latency resource record set for each Amazon\u003cbr/\u003e EC2 Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You aren\u0026rsquo;t required to create latency resource record sets for all Amazon\u003cbr/\u003e EC2 Regions. Route 53 will choose the region with the best latency from\u003cbr/\u003e among the regions that you create latency resource record sets for.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create non-latency resource record sets that have the same\u003cbr/\u003e values for the Name and Type elements as latency resource record sets. |\n| **resourceRecords**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eInformation about the resource records to act upon.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecords. |\n| **resourceRecords.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation specific to the resource record.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecord. || \u003cstrong\u003eresourceRecords.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eResource record sets that have a routing policy other than simple: An identifier\u003cbr/\u003ethat differentiates among multiple resource record sets that have the same\u003cbr/\u003ecombination of name and type, such as multiple weighted resource record sets\u003cbr/\u003enamed acme.example.com that have a type of A. In a group of resource record\u003cbr/\u003esets that have the same name and type, the value of SetIdentifier must be\u003cbr/\u003eunique for each resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about routing policies, see Choosing a Routing Policy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide. |\n| \u003cstrong\u003ettl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe resource record cache time to live (TTL), in seconds. Note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you\u0026rsquo;re creating or updating an alias resource record set, omit TTL.\u003cbr/\u003e Amazon Route 53 uses the value of TTL for the alias target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you\u0026rsquo;re associating this resource record set with a health check (if\u003cbr/\u003e you\u0026rsquo;re adding a HealthCheckId element), we recommend that you specify\u003cbr/\u003e a TTL of 60 seconds or less so clients respond quickly to changes in health\u003cbr/\u003e status.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * All of the resource record sets in a group of weighted resource record\u003cbr/\u003e sets must have the same value for TTL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If a group of weighted resource record sets includes one or more weighted\u003cbr/\u003e alias resource record sets for which the alias target is an ELB load balancer,\u003cbr/\u003e we recommend that you specify a TTL of 60 seconds for all of the non-alias\u003cbr/\u003e weighted resource record sets that have the same name and type. Values\u003cbr/\u003e other than 60 seconds (the TTL for load balancers) will change the effect\u003cbr/\u003e of the values that you specify for Weight. |\n| \u003cstrong\u003eweight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eWeighted resource record sets only: Among resource record sets that have\u003cbr/\u003ethe same combination of DNS name and type, a value that determines the proportion\u003cbr/\u003eof DNS queries that Amazon Route 53 responds to using the current resource\u003cbr/\u003erecord set. Route 53 calculates the sum of the weights for the resource record\u003cbr/\u003esets that have the same combination of DNS name and type. Route 53 then responds\u003cbr/\u003eto queries based on the ratio of a resource\u0026rsquo;s weight to the total. Note the\u003cbr/\u003efollowing:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You must specify a value for the Weight element for every weighted resource\u003cbr/\u003e record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only specify one ResourceRecord per weighted resource record\u003cbr/\u003e set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create latency, failover, or geolocation resource record sets\u003cbr/\u003e that have the same values for the Name and Type elements as weighted resource\u003cbr/\u003e record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can create a maximum of 100 weighted resource record sets that have\u003cbr/\u003e the same values for the Name and Type elements.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For weighted (but not weighted alias) resource record sets, if you set\u003cbr/\u003e Weight to 0 for a resource record set, Route 53 never responds to queries\u003cbr/\u003e with the applicable value for that resource record set. However, if you\u003cbr/\u003e set Weight to 0 for all resource record sets that have the same combination\u003cbr/\u003e of DNS name and type, traffic is routed to all resources with equal probability.\u003cbr/\u003e The effect of setting Weight to 0 is different when you associate health\u003cbr/\u003e checks with weighted resource record sets. For more information, see Options\u003cbr/\u003e for Configuring Route 53 Active-Active and Active-Passive Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html)\u003cbr/\u003e in the Amazon Route 53 Developer Guide. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nstatus: string\nsubmittedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html)\u003cbr/\u003eaction to get detailed information about the change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the request. PENDING indicates that this request has\u003cbr/\u003enot yet been applied to all Amazon Route 53 DNS servers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubmittedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the change request was submitted in ISO 8601 format\u003cbr/\u003e(https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time (UTC).\u003cbr/\u003eFor example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017\u003cbr/\u003eat 17:48:16.751 UTC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:152,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/replicationgroup/",title:"ReplicationGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#ReplicationGroup"\u003eelasticache-controller/apis/v1alpha1#ReplicationGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eReplicationGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eReplicationGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ereplicationgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ereplicationgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains all of the attributes of a specific Redis replication group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eatRestEncryptionEnabled: boolean\nauthToken: \n key: string\n name: string\n namespace: string\nautomaticFailoverEnabled: boolean\ncacheNodeType: string\ncacheParameterGroupName: string\ncacheParameterGroupRef: \n from: \n name: string\ncacheSecurityGroupNames:\n- string\ncacheSubnetGroupName: string\ncacheSubnetGroupRef: \n from: \n name: string\ndataTieringEnabled: boolean\ndescription: string\nengine: string\nengineVersion: string\nkmsKeyID: string\nlogDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n enabled: boolean\n logFormat: string\n logType: string\nmultiAZEnabled: boolean\nnodeGroupConfiguration:\n- nodeGroupID: string\n primaryAvailabilityZone: string\n primaryOutpostARN: string\n replicaAvailabilityZones:\n - string\n replicaCount: integer\n replicaOutpostARNs:\n - string\n slots: string\nnotificationTopicARN: string\nnumNodeGroups: integer\nport: integer\npreferredCacheClusterAZs:\n- string\npreferredMaintenanceWindow: string\nprimaryClusterID: string\nreplicasPerNodeGroup: integer\nreplicationGroupID: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nsnapshotARNs:\n- string\nsnapshotName: string\nsnapshotRetentionLimit: integer\nsnapshotWindow: string\ntags:\n- key: string\n value: string\ntransitEncryptionEnabled: boolean\nuserGroupIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eatRestEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag that enables encryption at rest when set to true. \u003cbr/\u003e You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. \u003cbr/\u003e Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \u003cbr/\u003e Default: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReserved parameter. The password used to access a password protected server. \u003cbr/\u003e AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. \u003cbr/\u003e For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. \u003cbr/\u003e Password constraints: \u003cbr/\u003e * Must be only printable ASCII characters. \u003cbr/\u003e * Must be at least 16 characters and no more than 128 characters in length. \u003cbr/\u003e * The only permitted printable special characters are !, \u0026amp;, #, $, ^, \u0026lt;, \u0026gt;, and -. Other printable special characters cannot be used in the AUTH token. \u003cbr/\u003e For more information, see AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailoverEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. \u003cbr/\u003e AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. \u003cbr/\u003e Default: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheNodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the nodes in the node group (shard). \u003cbr/\u003e The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. \u003cbr/\u003e * General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge \u003cbr/\u003e * Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge \u003cbr/\u003e * Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge \u003cbr/\u003e * Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge \u003cbr/\u003e Additional node type info \u003cbr/\u003e * All current generation instance types are created in Amazon VPC by default. \u003cbr/\u003e * Redis append-only files (AOF) are not supported for T1 or T2 instances. \u003cbr/\u003e * Redis Multi-AZ with automatic failover is not supported on T1 instances. \u003cbr/\u003e * Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. \u003cbr/\u003e If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. \u003cbr/\u003e * To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. \u003cbr/\u003e * To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSecurityGroupNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of cache security group names to associate with this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSecurityGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTieringEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-created description for the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache engine to be used for the clusters in this replication group. Must be Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. \u003cbr/\u003e Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the disk in the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. \u003cbr/\u003e If you\u0026rsquo;re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].primaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].primaryOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaAvailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaAvailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaOutpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotificationTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. \u003cbr/\u003e The Amazon SNS topic owner must be the same as the cluster owner.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumNodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eAn optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. \u003cbr/\u003e Default: 1\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which each member of the replication group accepts connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredCacheClusterAZs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 Availability Zones in which the replication group\u0026rsquo;s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. \u003cbr/\u003e This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. \u003cbr/\u003e If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. \u003cbr/\u003e The number of Availability Zones listed must equal the value of NumCacheClusters. \u003cbr/\u003e Default: system chosen Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredCacheClusterAZs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. \u003cbr/\u003e This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicasPerNodeGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eAn optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe replication group identifier. This parameter is stored as a lowercase string. \u003cbr/\u003e Constraints: \u003cbr/\u003e * A name must contain from 1 to 40 alphanumeric characters or hyphens. \u003cbr/\u003e * The first character must be a letter. \u003cbr/\u003e * A name cannot end with a hyphen or contain two consecutive hyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more Amazon VPC security groups associated with this replication group. \u003cbr/\u003e Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. \u003cbr/\u003e Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. \u003cbr/\u003e Default: 0 (i.e., automatic backups are disabled for this cluster).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). \u003cbr/\u003e Example: 05:00-09:00 \u003cbr/\u003e If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransitEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag that enables in-transit encryption when set to true. \u003cbr/\u003e You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. \u003cbr/\u003e This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. \u003cbr/\u003e If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. \u003cbr/\u003e Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \u003cbr/\u003e Default: false \u003cbr/\u003e For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe user group to associate with the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallowedScaleDownModifications:\n- string\nallowedScaleUpModifications:\n- string\nauthTokenEnabled: boolean\nauthTokenLastModifiedDate: string\nautoMinorVersionUpgrade: boolean\nautomaticFailover: string\nclusterEnabled: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfigurationEndpoint: \n address: string\n port: integer\ndataTiering: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nglobalReplicationGroupInfo: \n globalReplicationGroupID: string\n globalReplicationGroupMemberRole: string\nlogDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n logFormat: string\n logType: string\n message: string\n status: string\nmemberClusters:\n- string\nmemberClustersOutpostARNs:\n- string\nmultiAZ: string\nnodeGroups:\n- nodeGroupID: string\n nodeGroupMembers:\n - cacheClusterID: string\n cacheNodeID: string\n currentRole: string\n preferredAvailabilityZone: string\n preferredOutpostARN: string\n readEndpoint: \n address: string\n port: integer\n primaryEndpoint: \n address: string\n port: integer\n readerEndpoint: \n address: string\n port: integer\n slots: string\n status: string\npendingModifiedValues: \n authTokenStatus: string\n automaticFailoverStatus: string\n logDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n logFormat: string\n logType: string\n primaryClusterID: string\n resharding: \n slotMigration: \n progressPercentage: number\n userGroups: \n userGroupIDsToAdd:\n - string\n userGroupIDsToRemove:\n - string\nreplicationGroupCreateTime: string\nsnapshottingClusterID: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownModifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownModifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleUpModifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthTokenLastModifiedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the auth token was last modified\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the status of automatic failover for this Redis replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). \u003cbr/\u003e Valid values: true\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name of the Global datastore and role of this replication group in the Global datastore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo.globalReplicationGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo.globalReplicationGroupMemberRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReturns the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClusters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe names of all the cache clusters that are part of this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClusters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClustersOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single node within a node group (shard).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].cacheNodeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].currentRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].preferredAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].preferredOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA group of settings to be applied to the replication group, either immediately or during the next maintenance window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.authTokenStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.automaticFailoverStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log delivery configurations being modified\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.primaryClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding.slotMigration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the progress of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding.slotMigration.progressPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the user group update.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshottingClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster ID that is used as the daily snapshot source for the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:153,href:"https://aws-controllers-k8s.github.io/community/reference/ecr/v1alpha1/repository/",title:"Repository",description:null,content:'\u003cp\u003e\u003ccode\u003eecr.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecr-controller/apis/v1alpha1#Repository"\u003eecr-controller/apis/v1alpha1#Repository\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRepository\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRepositoryList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erepositories\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erepository\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing a repository.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eencryptionConfiguration: \n encryptionType: string\n kmsKey: string\nimageScanningConfiguration: \n scanOnPush: boolean\nimageTagMutability: string\nlifecyclePolicy: string\nname: string\npolicy: string\nregistryID: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the repository. This determines how the\u003cbr/\u003econtents of your repository are encrypted at rest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.encryptionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageScanningConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe image scanning configuration for the repository. This determines whether\u003cbr/\u003eimages are scanned for known vulnerabilities after being pushed to the repository.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageScanningConfiguration.scanOnPush\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageTagMutability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe tag mutability setting for the repository. If this parameter is omitted,\u003cbr/\u003ethe default setting of MUTABLE will be used which will allow image tags to\u003cbr/\u003ebe overwritten. If IMMUTABLE is specified, all image tags within the repository\u003cbr/\u003ewill be immutable which will prevent them from being overwritten.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON repository policy text to apply to the repository.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name to use for the repository. The repository name may be specified\u003cbr/\u003eon its own (such as nginx-web-app) or it can be prepended with a namespace\u003cbr/\u003eto group the repository into a category (such as project-a/nginx-web-app).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON repository policy text to apply to the repository. For more information,\u003cbr/\u003esee Amazon ECR repository policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html)\u003cbr/\u003ein the Amazon Elastic Container Registry User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregistryID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID associated with the registry to create\u003cbr/\u003ethe repository. If you do not specify a registry, the default registry is\u003cbr/\u003eassumed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the repository to help you categorize and\u003cbr/\u003eorganize them. Each tag consists of a key and an optional value, both of\u003cbr/\u003ewhich you define. Tag keys can have a maximum character length of 128 characters,\u003cbr/\u003eand tag values can have a maximum length of 256 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata to apply to a resource to help you categorize and organize them.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEach tag consists of a key and a value, both of which you define. Tag keys\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan have a maximum character length of 128 characters, and tag values can\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ehave a maximum length of 256 characters.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nrepositoryURI: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in JavaScript date format, when the repository was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erepositoryURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URI for the repository. You can use this URI for container image push\u003cbr/\u003eand pull operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:154,href:"https://aws-controllers-k8s.github.io/community/reference/route53resolver/v1alpha1/resolverendpoint/",title:"ResolverEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53resolver.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53resolver-controller/apis/v1alpha1#ResolverEndpoint"\u003eroute53resolver-controller/apis/v1alpha1#ResolverEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIn the response to a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html),\nDeleteResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html),\nGetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html),\nUpdates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint\n(https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html)\nrequest, a complex type that contains settings for an existing inbound or\noutbound Resolver endpoint.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edirection: string\nipAddresses:\n- ip: string\n ipv6: string\n subnetID: string\n subnetRef: \n from: \n name: string\nname: string\nresolverEndpointType: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edirection\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the applicable value:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * INBOUND: Resolver forwards DNS queries to the DNS service for a VPC\u003cbr/\u003e from your network\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC\u003cbr/\u003e to your network\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe subnets and IP addresses in your VPC that DNS queries originate from\u003cbr/\u003e(for outbound endpoints) or that you forward DNS queries to (for inbound\u003cbr/\u003eendpoints). The subnet ID uniquely identifies a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, the IP address that DNS queries originate from (for outbound endpoints)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor that you forward DNS queries to (for inbound endpoints). IpAddressRequest\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ealso includes the ID of the subnet that contains the IP address.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].ipv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name that lets you easily find a configuration in the Resolver\u003cbr/\u003edashboard in the Route 53 console.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolverEndpointType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor the endpoint type you can choose either IPv4, IPv6. or dual-stack. A\u003cbr/\u003edual-stack endpoint means that it will resolve via both IPv4 and IPv6. This\u003cbr/\u003eendpoint type is applied to all IP addresses.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe ID of one or more security groups that you want to use to control access\u003cbr/\u003eto this VPC. The security group that you specify must include one or more\u003cbr/\u003einbound rules (for inbound Resolver endpoints) or outbound rules (for outbound\u003cbr/\u003eResolver endpoints). Inbound and outbound rules must allow TCP and UDP access.\u003cbr/\u003eFor inbound access, open port 53. For outbound access, open the port that\u003cbr/\u003eyou\u0026rsquo;re using for DNS queries on your network.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the tag keys and values that you want to associate with the endpoint. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne tag that you want to add to the specified resource. A tag consists of\na Key (a name for the tag) and a Value. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncreatorRequestID: string\nhostVPCID: string\nid: string\nipAddressCount: integer\nmodificationTime: string\nstatus: string\nstatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was created, in Unix time format and\u003cbr/\u003eCoordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique string that identifies the request that created the Resolver endpoint.\u003cbr/\u003eThe CreatorRequestId allows failed requests to be retried without the risk\u003cbr/\u003eof running the operation twice.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostVPCID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC that you want to create the Resolver endpoint in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Resolver endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of IP addresses that the Resolver endpoint can use for DNS queries.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodificationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was last modified, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA code that specifies the current status of the Resolver endpoint. Valid\u003cbr/\u003evalues include the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING: Resolver is creating and configuring one or more Amazon VPC\u003cbr/\u003e network interfaces for this endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OPERATIONAL: The Amazon VPC network interfaces for this endpoint are\u003cbr/\u003e correctly configured and able to pass inbound or outbound DNS queries\u003cbr/\u003e between your network and Resolver.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING: Resolver is associating or disassociating one or more network\u003cbr/\u003e interfaces with this endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AUTO_RECOVERING: Resolver is trying to recover one or more of the network\u003cbr/\u003e interfaces that are associated with this endpoint. During the recovery\u003cbr/\u003e process, the endpoint functions with limited capacity because of the limit\u003cbr/\u003e on the number of DNS queries per IP address (per network interface). For\u003cbr/\u003e the current limit, see Limits on Route 53 Resolver (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTION_NEEDED: This endpoint is unhealthy, and Resolver can\u0026rsquo;t automatically\u003cbr/\u003e recover it. To resolve the problem, we recommend that you check each IP\u003cbr/\u003e address that you associated with the endpoint. For each IP address that\u003cbr/\u003e isn\u0026rsquo;t available, add another IP address and then delete the IP address\u003cbr/\u003e that isn\u0026rsquo;t available. (An endpoint must always include at least two IP\u003cbr/\u003e addresses.) A status of ACTION_NEEDED can have a variety of causes. Here\u003cbr/\u003e are two common causes: One or more of the network interfaces that are\u003cbr/\u003e associated with the endpoint were deleted using Amazon VPC. The network\u003cbr/\u003e interface couldn\u0026rsquo;t be created for some reason that\u0026rsquo;s outside the control\u003cbr/\u003e of Resolver.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING: Resolver is deleting this endpoint and the associated network\u003cbr/\u003e interfaces.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA detailed description of the status of the Resolver endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:155,href:"https://aws-controllers-k8s.github.io/community/reference/route53resolver/v1alpha1/resolverrule/",title:"ResolverRule",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53resolver.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53resolver-controller/apis/v1alpha1#ResolverRule"\u003eroute53resolver-controller/apis/v1alpha1#ResolverRule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverrules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverrule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor queries that originate in your VPC, detailed information about a Resolver\nrule, which specifies how to route DNS queries out of the VPC. The ResolverRule\nparameter appears in the response to a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html),\nDeleteResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html),\nGetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html),\nListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html),\nor UpdateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html)\nrequest.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassociations:\n- id: string\n name: string\n resolverRuleID: string\n status: string\n statusMessage: string\n vpcID: string\ndomainName: string\nname: string\nresolverEndpointID: string\nruleType: string\ntags:\n- key: string\n value: string\ntargetIPs:\n- ip: string\n ipv6: string\n port: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn the response to an AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html),\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDisassociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html),\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, provides information about an association between a Resolver rule\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand a VPC. The association determines which DNS queries that originate in\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe VPC are forwarded to your network.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].resolverRuleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDNS queries for this domain name are forwarded to the IP addresses that you\u003cbr/\u003especify in TargetIps. If a query matches multiple Resolver rules (example.com\u003cbr/\u003eand www.example.com), outbound DNS queries are routed using the Resolver\u003cbr/\u003erule that contains the most specific domain name (www.example.com).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name that lets you easily find a rule in the Resolver dashboard\u003cbr/\u003ein the Route 53 console.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolverEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the outbound Resolver endpoint that you want to use to route DNS\u003cbr/\u003equeries to the IP addresses that you specify in TargetIps.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you want to forward DNS queries for specified domain name to resolvers\u003cbr/\u003eon your network, specify FORWARD.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you have a forwarding rule to forward DNS queries for a domain to your\u003cbr/\u003enetwork and you want Resolver to process queries for a subdomain of that\u003cbr/\u003edomain, specify SYSTEM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to forward DNS queries for example.com to resolvers on your\u003cbr/\u003enetwork, you create a rule and specify FORWARD for RuleType. To then have\u003cbr/\u003eResolver process queries for apex.example.com, you create a rule and specify\u003cbr/\u003eSYSTEM for RuleType.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCurrently, only Resolver can create rules that have a value of RECURSIVE\u003cbr/\u003efor RuleType.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the tag keys and values that you want to associate with the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne tag that you want to add to the specified resource. A tag consists of\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea Key (a name for the tag) and a Value.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IPs that you want Resolver to forward DNS queries to. You can specify\u003cbr/\u003eonly IPv4 addresses. Separate IP addresses with a space.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTargetIps is available only when the value of Rule type is FORWARD.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, an array of the IPs that you want to forward DNS queries to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[].ipv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[].port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncreatorRequestID: string\nid: string\nmodificationTime: string\nownerID: string\nshareStatus: string\nstatus: string\nstatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Resolver rule was created, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique string that you specified when you created the Resolver rule. CreatorRequestId\u003cbr/\u003eidentifies the request and allows failed requests to be retried without the\u003cbr/\u003erisk of running the operation twice.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID that Resolver assigned to the Resolver rule when you created it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodificationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Resolver rule was last updated, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen a rule is shared with another Amazon Web Services account, the account\u003cbr/\u003eID of the account that the rule is shared with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshareStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether the rule is shared and, if so, whether the current account is sharing\u003cbr/\u003ethe rule with another account, or another account is sharing the rule with\u003cbr/\u003ethe current account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA code that specifies the current status of the Resolver rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA detailed description of the status of a Resolver rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:156,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/responseheaderspolicy/",title:"ResponseHeadersPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#ResponseHeadersPolicy"\u003ecloudfront-controller/apis/v1alpha1#ResponseHeadersPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResponseHeadersPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResponseHeadersPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresponseheaderspolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresponseheaderspolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA response headers policy.\u003c/p\u003e\n\u003cp\u003eA response headers policy contains information about a set of HTTP response\nheaders.\u003c/p\u003e\n\u003cp\u003eAfter you create a response headers policy, you can use its ID to attach\nit to one or more cache behaviors in a CloudFront distribution. When it\u0026rsquo;s\nattached to a cache behavior, the response headers policy affects the HTTP\nheaders that CloudFront includes in HTTP responses to requests that match\nthe cache behavior. CloudFront adds or removes response headers according\nto the configuration of the response headers policy.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding or removing HTTP headers in CloudFront responses\n(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html)\nin the Amazon CloudFront Developer Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresponseHeadersPolicyConfig: \n comment: string\n corsConfig: \n accessControlAllowCredentials: boolean\n accessControlAllowHeaders: \n items:\n - string\n accessControlAllowMethods: \n items:\n - string\n accessControlAllowOrigins: \n items:\n - string\n accessControlExposeHeaders: \n items:\n - string\n accessControlMaxAgeSec: integer\n originOverride: boolean\n customHeadersConfig: \n items:\n - header: string\n override: boolean\n value: string\n name: string\n removeHeadersConfig: \n items:\n - header: string\n securityHeadersConfig: \n contentSecurityPolicy: \n contentSecurityPolicy: string\n override: boolean\n contentTypeOptions: \n override: boolean\n frameOptions: \n frameOption: string\n override: boolean\n referrerPolicy: \n override: boolean\n referrerPolicy: string\n strictTransportSecurity: \n accessControlMaxAgeSec: integer\n includeSubdomains: boolean\n override: boolean\n preload: boolean\n xSSProtection: \n modeBlock: boolean\n override: boolean\n protection: boolean\n reportURI: string\n serverTimingHeadersConfig: \n enabled: boolean\n samplingRate: number\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains metadata about the response headers policy, and a set of configurations\u003cbr/\u003ethat specify the HTTP headers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a set of HTTP response headers that are used for cross-origin\u003cbr/\u003eresource sharing (CORS). CloudFront adds these headers to HTTP responses\u003cbr/\u003ethat it sends for CORS requests that match a cache behavior associated with\u003cbr/\u003ethis response headers policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CORS, see Cross-Origin Resource Sharing (CORS)\u003cbr/\u003e(https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers\u003cbr/\u003eHTTP response header.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Access-Control-Allow-Headers HTTP response\u003cbr/\u003eheader, see Access-Control-Allow-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowOrigins.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowOrigins.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlExposeHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlExposeHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.originOverride\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP response header names and their values. CloudFront includes\u003cbr/\u003ethese headers in HTTP responses that it sends for requests that match a cache\u003cbr/\u003ebehavior that\u0026rsquo;s associated with this response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn HTTP response header name and its value. CloudFront includes this header\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein HTTP responses that it sends for requests that match a cache behavior\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat\u0026rsquo;s associated with this response headers policy.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[].override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP header names that CloudFront removes from HTTP responses to\u003cbr/\u003erequests that match the cache behavior that this response headers policy\u003cbr/\u003eis attached to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name of an HTTP header that CloudFront removes from HTTP responses to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequests that match the cache behavior that this response headers policy\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eis attached to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a set of security-related HTTP response headers. CloudFront\u003cbr/\u003eadds these headers to HTTP responses that it sends for requests that match\u003cbr/\u003ea cache behavior associated with this response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe policy directives and their values that CloudFront includes as values\u003cbr/\u003efor the Content-Security-Policy HTTP response header.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Content-Security-Policy HTTP response header,\u003cbr/\u003esee Content-Security-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy.contentSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentTypeOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-Content-Type-Options HTTP response\u003cbr/\u003eheader with its value set to nosniff.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-Content-Type-Options HTTP response header,\u003cbr/\u003esee X-Content-Type-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentTypeOptions.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-Frame-Options HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-Frame-Options HTTP response header, see\u003cbr/\u003eX-Frame-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions.frameOption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the Referrer-Policy HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Referrer-Policy HTTP response header, see\u003cbr/\u003eReferrer-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy.referrerPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the Strict-Transport-Security HTTP\u003cbr/\u003eresponse header and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Strict-Transport-Security HTTP response header,\u003cbr/\u003esee Strict-Transport-Security (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.accessControlMaxAgeSec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.includeSubdomains\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.preload\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-XSS-Protection HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-XSS-Protection HTTP response header, see\u003cbr/\u003eX-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.modeBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.protection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.reportURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for enabling the Server-Timing header in HTTP responses sent\u003cbr/\u003efrom CloudFront. CloudFront adds this header to HTTP responses that it sends\u003cbr/\u003ein response to requests that match a cache behavior that\u0026rsquo;s associated with\u003cbr/\u003ethis response headers policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the Server-Timing header to view metrics that can help you gain\u003cbr/\u003einsights about the behavior and performance of CloudFront. For example, you\u003cbr/\u003ecan see which cache layer served a cache hit, or the first byte latency from\u003cbr/\u003ethe origin when there was a cache miss. You can use the metrics in the Server-Timing\u003cbr/\u003eheader to troubleshoot issues or test the efficiency of your CloudFront configuration.\u003cbr/\u003eFor more information, see Server-Timing header (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig.samplingRate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the response headers policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:157,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/role/",title:"Role",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Role"\u003eiam-controller/apis/v1alpha1#Role\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRole\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRoleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erole\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM role. This structure is returned as a response\nelement in several API operations that interact with roles.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassumeRolePolicyDocument: string\ndescription: string\ninlinePolicies: {}\nmaxSessionDuration: integer\nname: string\npath: string\npermissionsBoundary: string\npermissionsBoundaryRef: \n from: \n name: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassumeRolePolicyDocument\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe trust relationship policy document that grants an entity permission to\u003cbr/\u003eassume the role.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIn IAM, you must provide a JSON policy that has been converted to a string.\u003cbr/\u003eHowever, for CloudFormation templates formatted in YAML, you can provide\u003cbr/\u003ethe policy in JSON or YAML format. CloudFormation always converts a YAML\u003cbr/\u003epolicy to JSON format before submitting it to IAM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) used to validate this\u003cbr/\u003eparameter is a string of characters consisting of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Any printable ASCII character ranging from the space character (\\u0020)\u003cbr/\u003e through the end of the ASCII character range\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The special characters tab (\\u0009), line feed (\\u000A), and carriage\u003cbr/\u003e return (\\u000D)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUpon success, the response includes the same trust policy in JSON format.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxSessionDuration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum session duration (in seconds) that you want to set for the specified\u003cbr/\u003erole. If you do not specify a value for this setting, the default value of\u003cbr/\u003eone hour is applied. This setting can have a value from 1 hour to 12 hours.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAnyone who assumes the role from the CLI or API can use the DurationSeconds\u003cbr/\u003eAPI parameter or the duration-seconds CLI parameter to request a longer session.\u003cbr/\u003eThe MaxSessionDuration setting determines the maximum duration that can be\u003cbr/\u003erequested using the DurationSeconds parameter. If users don\u0026rsquo;t specify a value\u003cbr/\u003efor the DurationSeconds parameter, their security credentials are valid for\u003cbr/\u003eone hour by default. This applies when you use the AssumeRole* API operations\u003cbr/\u003eor the assume-role* CLI operations but does not apply when you use those\u003cbr/\u003eoperations to create a console URL. For more information, see Using IAM roles\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the\u003cbr/\u003eIAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the role to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of upper and lowercase alphanumeric characters\u003cbr/\u003ewith no spaces. You can also include any of the following characters: _+=,.@-\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the role. For more information about paths, see IAM Identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the managed policy that is used to set the permissions boundary\u003cbr/\u003efor the role.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA permissions boundary policy defines the maximum permissions that identity-based\u003cbr/\u003epolicies can grant to an entity, but does not grant permissions. Permissions\u003cbr/\u003eboundaries do not define the maximum permissions that a resource-based policy\u003cbr/\u003ecan grant to an entity. To learn more, see Permissions boundaries for IAM\u003cbr/\u003eentities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about policy types, see Policy types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new role. Each tag consists\u003cbr/\u003eof a key name and an associated value. For more information about tagging,\u003cbr/\u003esee Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\nwith an IAM resource. For more information about tagging, see Tagging IAM\nresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\nin the IAM User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\nroleID: string\nroleLastUsed: \n lastUsedDate: string\n region: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the role was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the role. For more information about\u003cbr/\u003eIDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the last time that an IAM role was used. This\u003cbr/\u003eincludes the date and time and the Region in which the role was last used.\u003cbr/\u003eActivity is only reported for the trailing 400 days. This period can be shorter\u003cbr/\u003eif your Region began supporting these features within the last year. The\u003cbr/\u003erole might have been used more than 400 days ago. For more information, see\u003cbr/\u003eRegions where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period)\u003cbr/\u003ein the IAM user Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed.lastUsedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:158,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/route/",title:"Route",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Route"\u003eapigatewayv2-controller/apis/v1alpha1#Route\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRoute\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutes\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroute\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a route.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiKeyRequired: boolean\napiRef: \n from: \n name: string\nauthorizationScopes:\n- string\nauthorizationType: string\nauthorizerID: string\nauthorizerRef: \n from: \n name: string\nmodelSelectionExpression: string\noperationName: string\nrequestModels: {}\nrequestParameters: {}\nrouteKey: string\nrouteResponseSelectionExpression: string\ntarget: string\ntargetRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiKeyRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizationScopes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizationScopes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestModels\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteKey\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteResponseSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nrouteID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:159,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/routetable/",title:"RouteTable",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#RouteTable"\u003eec2-controller/apis/v1alpha1#RouteTable\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutetables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutetable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a route table.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eroutes:\n- carrierGatewayID: string\n coreNetworkARN: string\n destinationCIDRBlock: string\n destinationIPv6CIDRBlock: string\n destinationPrefixListID: string\n egressOnlyInternetGatewayID: string\n gatewayID: string\n gatewayRef: \n from: \n name: string\n instanceID: string\n localGatewayID: string\n natGatewayID: string\n natGatewayRef: \n from: \n name: string\n networkInterfaceID: string\n transitGatewayID: string\n transitGatewayRef: \n from: \n name: string\n vpcEndpointID: string\n vpcEndpointRef: \n from: \n name: string\n vpcPeeringConnectionID: string\n vpcPeeringConnectionRef: \n from: \n name: string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].coreNetworkARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationCIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationPrefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].egressOnlyInternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for GatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].instanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].localGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for NATGatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for TransitGatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for VPCEndpointID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for VPCPeeringConnectionID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociations:\n associationState: \n state: string\n statusMessage: string\n gatewayID: string\n main: boolean\n routeTableAssociationID: string\n routeTableID: string\n subnetID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nownerID: string\npropagatingVGWs:\n- gatewayID: string\nrouteStatuses:\n- carrierGatewayID: string\n coreNetworkARN: string\n destinationCIDRBlock: string\n destinationIPv6CIDRBlock: string\n destinationPrefixListID: string\n egressOnlyInternetGatewayID: string\n gatewayID: string\n instanceID: string\n instanceOwnerID: string\n localGatewayID: string\n natGatewayID: string\n networkInterfaceID: string\n origin: string\n state: string\n transitGatewayID: string\n vpcPeeringConnectionID: string\nrouteTableID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe associations between the route table and one or more subnets or a gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a route table and a subnet or gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].associationState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].associationState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].main\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].routeTableAssociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].routeTableID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epropagatingVGWs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAny virtual private gateway (VGW) propagating routes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epropagatingVGWs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a virtual private gateway propagating route.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe routes in the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a route in a route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].coreNetworkARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationCIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationPrefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].egressOnlyInternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].instanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].instanceOwnerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].localGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].natGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].origin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].transitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:160,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/rule/",title:"Rule",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Rule"\u003eeventbridge-controller/apis/v1alpha1#Rule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a rule in Amazon EventBridge.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventBusName: string\neventBusRef: \n from: \n name: string\neventPattern: string\nname: string\nroleARN: string\nscheduleExpression: string\nstate: string\ntags:\n- key: string\n value: string\ntargets:\n- arn: string\n batchParameters: \n arrayProperties: \n size: integer\n jobDefinition: string\n jobName: string\n retryStrategy: \n attempts: integer\n deadLetterConfig: \n arn: string\n ecsParameters: \n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n enableECSManagedTags: boolean\n enableExecuteCommand: boolean\n group: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n placementConstraints:\n - expression: string\n type_: string\n placementStrategy:\n - field: string\n type_: string\n platformVersion: string\n propagateTags: string\n referenceID: string\n tags:\n - key: string\n value: string\n taskCount: integer\n taskDefinitionARN: string\n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n id: string\n input: string\n inputPath: string\n inputTransformer: \n inputPathsMap: {}\n inputTemplate: string\n kinesisParameters: \n partitionKeyPath: string\n redshiftDataParameters: \n database: string\n dbUser: string\n secretManagerARN: string\n sql: string\n sqls:\n - string\n statementName: string\n withEvent: boolean\n retryPolicy: \n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n roleARN: string\n runCommandParameters: \n runCommandTargets:\n - key: string\n values:\n - string\n sageMakerPipelineParameters: \n pipelineParameterList:\n - name: string\n value: string\n sqsParameters: \n messageGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or ARN of the event bus to associate with this rule. If you omit\u003cbr/\u003ethis, the default event bus is used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventPattern\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe event pattern. For more information, see Amazon EventBridge event patterns\u003cbr/\u003e(https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\u003cbr/\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the rule that you are creating or updating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role associated with the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re setting an event bus in another account as the target and that\u003cbr/\u003eaccount granted permission to your account through an organization instead\u003cbr/\u003eof directly by the account ID, you must specify a RoleArn with proper permissions\u003cbr/\u003ein the Target structure, instead of here in this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escheduleExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scheduling expression. For example, \u0026ldquo;cron(0 20 * * ? *)\u0026rdquo; or \u0026ldquo;rate(5 minutes)\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values include:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DISABLED: The rule is disabled. EventBridge does not match any events\u003cbr/\u003e against the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ENABLED: The rule is enabled. EventBridge matches events against the\u003cbr/\u003e rule, except for Amazon Web Services management events delivered through\u003cbr/\u003e CloudTrail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for\u003cbr/\u003e all events, including Amazon Web Services management events delivered\u003cbr/\u003e through CloudTrail. Management events provide visibility into management\u003cbr/\u003e operations that are performed on resources in your Amazon Web Services\u003cbr/\u003e account. These are also known as control plane operations. For more information,\u003cbr/\u003e see Logging management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events)\u003cbr/\u003e in the CloudTrail User Guide, and Filtering management events from Amazon\u003cbr/\u003e Web Services services (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail)\u003cbr/\u003e in the Amazon EventBridge User Guide. This value is only valid for rules\u003cbr/\u003e on the default (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses)\u003cbr/\u003e event bus or custom event buses (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html).\u003cbr/\u003e It does not apply to partner event buses (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of key-value pairs to associate with the rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erules and event buses support tagging.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTargets are the resources to be invoked when a rule is triggered. For a complete\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003elist of services and resources that can be set as a target, see PutTargets\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you are setting the event bus of another account as the target, and that\naccount granted permission to your account through an organization instead\nof directly by the account ID, then you must specify a RoleArn with proper\npermissions in the Target structure. For more information, see Sending and\nReceiving Events Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html)\nin the Amazon EventBridge User Guide. || \u003cstrong\u003etargets.[].arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe custom parameters to be used when the target is an Batch job. |\n| \u003cstrong\u003etargets.[].batchParameters.arrayProperties\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe array properties for the submitted job, such as the size of the array.\u003cbr/\u003eThe array size can be between 2 and 10,000. If you specify array properties\u003cbr/\u003efor a job, it becomes an array job. This parameter is used only if the target\u003cbr/\u003eis an Batch job. |\n| \u003cstrong\u003etargets.[].batchParameters.arrayProperties.size\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.jobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.jobName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.retryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe retry strategy to use for failed jobs, if the target is an Batch job.\u003cbr/\u003eIf you specify a retry strategy here, it overrides the retry strategy defined\u003cbr/\u003ein the job definition. |\n| \u003cstrong\u003etargets.[].batchParameters.retryStrategy.attempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration. |\n| \u003cstrong\u003etargets.[].deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe custom parameters to be used when the target is an Amazon ECS task. |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem\n(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html)\nin the Amazon ECS API Reference. || \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.enableECSManagedTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.enableExecuteCommand\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.group\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the network configuration for an ECS task. |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the task,\u003cbr/\u003eand whether a public IP address is to be used. This structure is relevant\u003cbr/\u003eonly for ECS tasks that use the awsvpc network mode. |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etargets.[].ecsParameters.placementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.placementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a constraint on task placement. To learn more, see\nTask Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003etargets.[].ecsParameters.placementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementConstraints.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe task placement strategy for a task or service. To learn more, see Task\nPlacement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Service Developer Guide. || **targets.[].ecsParameters.placementStrategy.[].field**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.platformVersion**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.propagateTags**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.referenceID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\nrules and event buses support tagging. || **targets.[].ecsParameters.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.taskCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].ecsParameters.taskDefinitionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].httpParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway APIs\u003cbr/\u003eor EventBridge ApiDestinations. In the latter case, these are merged with\u003cbr/\u003eany InvocationParameters specified on the Connection, with any values from\u003cbr/\u003ethe Connection taking precedence. |\n| **targets.[].httpParameters.headerParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].httpParameters.pathParameterValues**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].httpParameters.pathParameterValues.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].httpParameters.queryStringParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].input**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].inputPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].inputTransformer**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContains the parameters needed for you to provide custom input to a target\u003cbr/\u003ebased on one or more pieces of data extracted from the event. |\n| **targets.[].inputTransformer.inputPathsMap**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].inputTransformer.inputTemplate**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].kinesisParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis object enables you to specify a JSON path to extract from the event\u003cbr/\u003eand use as the partition key for the Amazon Kinesis data stream, so that\u003cbr/\u003eyou can control the shard to which the event goes. If you do not include\u003cbr/\u003ethis parameter, the default is to use the eventId as the partition key. |\n| **targets.[].kinesisParameters.partitionKeyPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].redshiftDataParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to be used when the target is a Amazon Redshift\u003cbr/\u003ecluster to invoke the Amazon Redshift Data API ExecuteStatement based on\u003cbr/\u003eEventBridge events. |\n| **targets.[].redshiftDataParameters.database**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eRedshift Database |\n| **targets.[].redshiftDataParameters.dbUser**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eDatabase user name |\n| **targets.[].redshiftDataParameters.secretManagerARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eOptional SecretManager ARN which stores the database credentials |\n| **targets.[].redshiftDataParameters.sql**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eA single Redshift SQL |\n| **targets.[].redshiftDataParameters.sqls**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of SQLs. |\n| **targets.[].redshiftDataParameters.sqls.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].redshiftDataParameters.statementName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eA name for Redshift DataAPI statement which can be used as filter of ListStatement. |\n| **targets.[].redshiftDataParameters.withEvent**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targets.[].retryPolicy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA RetryPolicy object that includes information about the retry policy settings. |\n| **targets.[].retryPolicy.maximumEventAgeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].retryPolicy.maximumRetryAttempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].roleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].runCommandParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis parameter contains the criteria (either InstanceIds or a tag) used to\u003cbr/\u003especify which EC2 instances are to be sent the command. |\n| **targets.[].runCommandParameters.runCommandTargets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation about the EC2 instances that are to be sent the command, specified\nas key-value pairs. Each RunCommandTarget block can include only one key,\nbut this key may specify multiple values. || **targets.[].runCommandParameters.runCommandTargets.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[].values**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[].values.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].sageMakerPipelineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to use when the target is a SageMaker Model Building\u003cbr/\u003ePipeline that starts based on EventBridge events. |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eName/Value pair of a parameter to start execution of a SageMaker Model Building\nPipeline. || **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].sqsParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure includes the custom parameter to be used when the target is\u003cbr/\u003ean SQS FIFO queue. |\n| **targets.[].sqsParameters.messageGroupID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:161,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/rulegroup/",title:"RuleGroup",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#RuleGroup"\u003enetworkfirewall-controller/apis/v1alpha1#RuleGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe object that defines the rules in a rule group. This, along with RuleGroupResponse,\ndefine the rule group. You can retrieve all objects for a rule group by calling\nDescribeRuleGroup.\u003c/p\u003e\n\u003cp\u003eNetwork Firewall uses a rule group to inspect and control network traffic.\nYou define stateless rule groups to inspect individual packets and you define\nstateful rule groups to inspect packets in the context of their traffic flow.\u003c/p\u003e\n\u003cp\u003eTo use a rule group, you include it by reference in an Network Firewall firewall\npolicy, then you use the policy in a firewall. You can reference a rule group\nfrom more than one firewall policy, and you can use a firewall policy in\nmore than one firewall.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eanalyzeRuleGroup: boolean\ncapacity: integer\ndescription: string\ndryRun: boolean\nencryptionConfiguration: \n keyID: string\n type_: string\nruleGroup: \n referenceSets: \n iPSetReferences: {}\n ruleVariables: \n iPSets: {}\n portSets: {}\n rulesSource: \n rulesSourceList: \n generatedRulesType: string\n targetTypes:\n - string\n targets:\n - string\n rulesString: string\n statefulRules:\n - action: string\n header: \n destination: string\n destinationPort: string\n direction: string\n protocol: string\n source: string\n sourcePort: string\n ruleOptions:\n - keyword: string\n settings:\n - string\n statelessRulesAndCustomActions: \n customActions:\n actionDefinition: \n publishMetricAction: \n dimensions:\n - value: string\n actionName: string\n statelessRules:\n - priority: integer\n ruleDefinition: \n actions:\n - string\n matchAttributes: \n destinationPorts:\n - fromPort: integer\n toPort: integer\n destinations:\n - addressDefinition: string\n protocols:\n - integer\n sourcePorts:\n - fromPort: integer\n toPort: integer\n sources:\n - addressDefinition: string\n tcpFlags:\n flags:\n - string\n masks:\n - string\n statefulRuleOptions: \n ruleOrder: string\nruleGroupName: string\nrules: string\nsourceMetadata: \n sourceARN: string\n sourceUpdateToken: string\ntags:\n- key: string\n value: string\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalyzeRuleGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want Network Firewall to analyze the stateless rules\u003cbr/\u003ein the rule group for rule behavior such as asymmetric routing. If set to\u003cbr/\u003eTRUE, Network Firewall runs the analysis and then creates the rule group\u003cbr/\u003efor you. To run the stateless rule group analyzer without creating the rule\u003cbr/\u003egroup, set DryRun to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacity\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum operating resources that this rule group can use. Rule group\u003cbr/\u003ecapacity is fixed at creation. When you update a rule group, you are limited\u003cbr/\u003eto this capacity. When you reference a rule group from a firewall policy,\u003cbr/\u003eNetwork Firewall reserves this capacity for the rule group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can retrieve the capacity that would be required for a rule group before\u003cbr/\u003eyou create the rule group by calling CreateRuleGroup with DryRun set to TRUE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t change or exceed this capacity when you update the rule group,\u003cbr/\u003eso leave room for your rule group to grow.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCapacity for a stateless rule group\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a stateless rule group, the capacity required is the sum of the capacity\u003cbr/\u003erequirements of the individual rules that you expect to have in the rule\u003cbr/\u003egroup.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo calculate the capacity requirement of a single rule, multiply the capacity\u003cbr/\u003erequirement values of each of the rule\u0026rsquo;s match settings:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A match setting with no criteria specified has a value of 1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A match setting with Any specified has a value of 1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * All other match settings have a value equal to the number of elements\u003cbr/\u003e provided in the setting. For example, a protocol setting [\u0026ldquo;UDP\u0026rdquo;] and a\u003cbr/\u003e source setting [\u0026ldquo;10.0.0.0/24\u0026rdquo;] each have a value of 1. A protocol setting\u003cbr/\u003e [\u0026ldquo;UDP\u0026rdquo;,\u0026ldquo;TCP\u0026rdquo;] has a value of 2. A source setting [\u0026ldquo;10.0.0.0/24\u0026rdquo;,\u0026ldquo;10.0.0.1/24\u0026rdquo;,\u0026ldquo;10.0.0.2/24\u0026rdquo;]\u003cbr/\u003e has a value of 3.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA rule with no criteria specified in any of its match settings has a capacity\u003cbr/\u003erequirement of 1. A rule with protocol setting [\u0026ldquo;UDP\u0026rdquo;,\u0026ldquo;TCP\u0026rdquo;], source setting\u003cbr/\u003e[\u0026ldquo;10.0.0.0/24\u0026rdquo;,\u0026ldquo;10.0.0.1/24\u0026rdquo;,\u0026ldquo;10.0.0.2/24\u0026rdquo;], and a single specification or\u003cbr/\u003eno specification for each of the other match settings has a capacity requirement\u003cbr/\u003eof 6.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCapacity for a stateful rule group\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a stateful rule group, the minimum capacity required is the number of\u003cbr/\u003eindividual rules that you expect to have in the rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edryRun\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want Network Firewall to just check the validity of\u003cbr/\u003ethe request, rather than run the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf set to TRUE, Network Firewall checks whether the request can run successfully,\u003cbr/\u003ebut doesn\u0026rsquo;t actually make the requested changes. The call returns the value\u003cbr/\u003ethat the request would return if you ran it with dry run set to FALSE, but\u003cbr/\u003edoesn\u0026rsquo;t make additions or changes to your resources. This option allows you\u003cbr/\u003eto make sure that you have the required permissions to run the request and\u003cbr/\u003ethat your request parameters are valid.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf set to FALSE, Network Firewall makes the requested changes to your resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your rule group resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that defines the rule group rules.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide either this rule group setting or a Rules setting, but not\u003cbr/\u003eboth.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.referenceSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a set of IP set references.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.referenceSets.iPSetReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that are available for use in the rules in the RuleGroup where this\u003cbr/\u003eis defined.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables.iPSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables.portSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe stateless or stateful rules definitions for use in a single rule group.\u003cbr/\u003eEach rule group requires a single RulesSource. You can use an instance of\u003cbr/\u003ethis for either stateless rules or stateful rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateful inspection criteria for a domain list rule group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor HTTPS traffic, domain filtering is SNI-based. It uses the server name\u003cbr/\u003eindicator extension of the TLS handshake.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, Network Firewall domain list inspection only includes traffic\u003cbr/\u003ecoming from the VPC where you deploy the firewall. To inspect traffic from\u003cbr/\u003eIP addresses outside of the deployment VPC, you set the HOME_NET rule variable\u003cbr/\u003eto include the CIDR range of the deployment VPC plus the other CIDR ranges.\u003cbr/\u003eFor more information, see RuleVariables in this guide and Stateful domain\u003cbr/\u003elist rule groups in Network Firewall (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.generatedRulesType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targetTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targetTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single Suricata rules specification, for use in a stateful rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse this option to specify a simple Suricata rule with protocol, source and\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edestination, ports, direction, and rule options. For information about the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSuricata Rules format, see Rules Format (https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe basic rule criteria for Network Firewall to use to inspect packet headers\u003cbr/\u003ein stateful traffic flow inspection. Traffic flows that match the criteria\u003cbr/\u003eare a match for the corresponding StatefulRule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.destinationPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.direction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.protocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.source\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.sourcePort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditional settings for a stateful rule. This is part of the StatefulRule\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econfiguration.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[].settings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[].settings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn optional, non-standard action to use for stateless packet handling. You\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan define this in addition to the standard action that you must specify.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou define and name the custom actions that you want to be able to use, and\nthen you reference them by name in your actions settings.\u003c/p\u003e\n\u003cp\u003eYou can use custom actions in the following places:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eIn a rule group\u0026rsquo;s StatelessRulesAndCustomActions specification. The\ncustom actions are available for use by name inside the StatelessRulesAndCustomActions\nwhere you define them. You can use them for your stateless rule actions\nto specify what to do with a packet that matches the rule\u0026rsquo;s match attributes.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIn a FirewallPolicy specification, in StatelessCustomActions. The custom\nactions are available for use inside the policy where you define them.\nYou can use them for the policy\u0026rsquo;s default stateless actions settings to\nspecify what to do with packets that don\u0026rsquo;t match any of the policy\u0026rsquo;s stateless\nrules. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom action to use in stateless rule actions settings. This is used in\u003cbr/\u003eCustomAction. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateless inspection criteria that publishes the specified metrics to Amazon\u003cbr/\u003eCloudWatch for the matching packet. This setting defines a CloudWatch dimension\u003cbr/\u003evalue to be published. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe value to use in an Amazon CloudWatch custom metric dimension. This is\nused in the PublishMetrics CustomAction. A CloudWatch custom metric dimension\nis a name/value pair that\u0026rsquo;s part of the identity of a metric.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eNetwork Firewall sets the dimension name to CustomAction and you provide\nthe dimension value.\u003c/p\u003e\n\u003cp\u003eFor more information about CloudWatch custom metric dimensions, see Publishing\nCustom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions)\nin the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single stateless rule. This is used in StatelessRulesAndCustomActions. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inspection criteria and action for a single stateless rule. Network Firewall\u003cbr/\u003einspects each packet for the specified matching criteria. When a packet matches\u003cbr/\u003ethe criteria, Network Firewall performs the rule\u0026rsquo;s actions on the packet. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.actions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.actions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCriteria for Network Firewall to use to inspect an individual packet in stateless\u003cbr/\u003erule inspection. Each match attributes set can include one or more items\u003cbr/\u003esuch as IP address, CIDR range, port number, protocol, and TCP flags. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single port range specification. This is used for source and destination\nport ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single IP address specification. This is used in the MatchAttributes source\nand destination specifications. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations.[].addressDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.protocols\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.protocols.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single port range specification. This is used for source and destination\nport ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single IP address specification. This is used in the MatchAttributes source\nand destination specifications. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources.[].addressDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTCP flags and masks to inspect packets for, used in stateless rules MatchAttributes\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].flags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].flags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].masks\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].masks.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.statefulRuleOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditional options governing how Network Firewall handles the rule group.\u003cbr/\u003eYou can only use these for stateful rule groups. |\n| \u003cstrong\u003eruleGroup.statefulRuleOptions.ruleOrder\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroupName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the rule group. You can\u0026rsquo;t change the name of a rule\u003cbr/\u003egroup after you create it. |\n| \u003cstrong\u003erules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string containing stateful rule group rules specifications in Suricata\u003cbr/\u003eflat format, with one rule per line. Use this to import your existing Suricata\u003cbr/\u003ecompatible rule groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide either this rules setting or a populated RuleGroup setting,\u003cbr/\u003ebut not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can provide your rule group specification in Suricata flat format through\u003cbr/\u003ethis setting when you create or update your rule group. The call response\u003cbr/\u003ereturns a RuleGroup object that Network Firewall has populated from your\u003cbr/\u003estring. |\n| \u003cstrong\u003esourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains metadata about the rule group that your own\u003cbr/\u003erule group is copied from. You can use the metadata to keep track of updates\u003cbr/\u003emade to the originating rule group. |\n| \u003cstrong\u003esourceMetadata.sourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esourceMetadata.sourceUpdateToken\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\npair can be anything you define. Typically, the tag key represents a category\n(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\nthat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\nup to 50 tags to each Amazon Web Services resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **type_**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eIndicates whether the rule group is stateless or stateful. If the rule group\u003cbr/\u003eis stateless, it contains stateless rules. If it is stateful, it contains\u003cbr/\u003estateful rules. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nruleGroupResponse: \n analysisResults:\n - analysisDetail: string\n identifiedRuleIDs:\n - string\n identifiedType: string\n capacity: integer\n consumedCapacity: integer\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n lastModifiedTime: string\n numberOfAssociations: integer\n ruleGroupARN: string\n ruleGroupID: string\n ruleGroupName: string\n ruleGroupStatus: string\n snsTopic: string\n sourceMetadata: \n sourceARN: string\n sourceUpdateToken: string\n tags:\n - key: string\n value: string\n type_: string\nupdateToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe high-level properties of a rule group. This, along with the RuleGroup,\u003cbr/\u003edefine the rule group. You can retrieve all objects for a rule group by calling\u003cbr/\u003eDescribeRuleGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe analysis result for Network Firewall\u0026rsquo;s stateless rule group analyzer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEvery time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eon a stateless rule group, Network Firewall analyzes the stateless rule groups\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein your account and identifies the rules that might adversely effect your\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efirewall\u0026rsquo;s functionality. For example, if Network Firewall detects a rule\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat\u0026rsquo;s routing traffic asymmetrically, which impacts the service\u0026rsquo;s ability\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto properly process traffic, the service includes the rule in a list of analysis\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresults.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[].identifiedRuleIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[].identifiedRuleIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.capacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.consumedCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**ruleGroupResponse.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.numberOfAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.snsTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eHigh-level information about the managed rule group that your own rule group\u003cbr/\u003eis copied from. You can use the the metadata to track version updates made\u003cbr/\u003eto the originating rule group. You can retrieve all objects for a rule group\u003cbr/\u003eby calling DescribeRuleGroup (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata.sourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata.sourceUpdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**ruleGroupResponse.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA token used for optimistic locking. Network Firewall returns a token to\u003cbr/\u003eyour requests that access the rule group. The token marks the state of the\u003cbr/\u003erule group resource at the time of the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo make changes to the rule group, you provide the token in your request.\u003cbr/\u003eNetwork Firewall uses the token to ensure that the rule group hasn\u0026rsquo;t changed\u003cbr/\u003esince you last retrieved it. If it has changed, the operation fails with\u003cbr/\u003ean InvalidTokenException. If this happens, retrieve the rule group again\u003cbr/\u003eto get a current copy of it with a current token. Reapply your changes as\u003cbr/\u003eneeded, then try the operation again using the new token.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:162,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/rulegroupsnamespace/",title:"RuleGroupsNamespace",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#RuleGroupsNamespace"\u003eprometheusservice-controller/apis/v1alpha1#RuleGroupsNamespace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupsNamespace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupsNamespaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroupsnamespaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroupsnamespace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfiguration: string\nname: string\ntags: {}\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe rule groups namespace name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional, user-provided tags for this rule groups namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace in which to create the rule group namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: \n statusCode: string\n statusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of rule groups namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eState of a namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:163,href:"https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalabletarget/",title:"ScalableTarget",description:null,content:'\u003cp\u003e\u003ccode\u003eapplicationautoscaling.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/applicationautoscaling-controller/apis/v1alpha1#ScalableTarget"\u003eapplicationautoscaling-controller/apis/v1alpha1#ScalableTarget\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalableTarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalableTargetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalabletargets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalabletarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a scalable target.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emaxCapacity: integer\nminCapacity: integer\nresourceID: string\nroleARN: string\nscalableDimension: string\nserviceNamespace: string\nsuspendedState: \n dynamicScalingInSuspended: boolean\n dynamicScalingOutSuspended: boolean\n scheduledScalingSuspended: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum value that you plan to scale out to. When a scaling policy is\u003cbr/\u003ein effect, Application Auto Scaling can scale out (expand) as needed to the\u003cbr/\u003emaximum capacity limit in response to changing demand. This property is required\u003cbr/\u003ewhen registering a new scalable target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlthough you can specify a large maximum capacity, note that service quotas\u003cbr/\u003emay impose lower limits. Each service has its own default quotas for the\u003cbr/\u003emaximum capacity of the resource. If you want to specify a higher limit,\u003cbr/\u003eyou can request an increase. For more information, consult the documentation\u003cbr/\u003efor that service. For information about the default quotas for each service,\u003cbr/\u003esee Service Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)\u003cbr/\u003ein the Amazon Web Services General Reference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe minimum value that you plan to scale in to. When a scaling policy is\u003cbr/\u003ein effect, Application Auto Scaling can scale in (contract) as needed to\u003cbr/\u003ethe minimum capacity limit in response to changing demand. This property\u003cbr/\u003eis required when registering a new scalable target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor certain resources, the minimum value allowed is 0. This includes Lambda\u003cbr/\u003eprovisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR\u003cbr/\u003eclusters, and custom resources. For all other resources, the minimum value\u003cbr/\u003eallowed is 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the resource that is associated with the scalable target.\u003cbr/\u003eThis string consists of the resource type and unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ECS service - The resource type is service and the unique identifier\u003cbr/\u003e is the cluster name and service name. Example: service/default/sample-webapp.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Spot Fleet - The resource type is spot-fleet-request and the unique\u003cbr/\u003e identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * EMR cluster - The resource type is instancegroup and the unique identifier\u003cbr/\u003e is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AppStream 2.0 fleet - The resource type is fleet and the unique identifier\u003cbr/\u003e is the fleet name. Example: fleet/sample-fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: table/my-table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB global secondary index - The resource type is index and the\u003cbr/\u003e unique identifier is the index name. Example: table/my-table/index/my-table-index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora DB cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:my-db-cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SageMaker endpoint variant - The resource type is variant and the unique\u003cbr/\u003e identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Custom resources are not supported with a resource type. This parameter\u003cbr/\u003e must specify the OutputValue from the CloudFormation template stack used\u003cbr/\u003e to access the resources. The unique identifier is defined by the service\u003cbr/\u003e provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend document classification endpoint - The resource type\u003cbr/\u003e and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend entity recognizer endpoint - The resource type and\u003cbr/\u003e unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Lambda provisioned concurrency - The resource type is function and the\u003cbr/\u003e unique identifier is the function name with a function version or alias\u003cbr/\u003e name suffix that is not $LATEST. Example: function:my-function:prod or\u003cbr/\u003e function:my-function:1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Keyspaces table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: keyspace/mykeyspace/table/mytable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MSK cluster - The resource type and unique identifier are specified\u003cbr/\u003e using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ElastiCache replication group - The resource type is replication-group\u003cbr/\u003e and the unique identifier is the replication group name. Example: replication-group/mycluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Neptune cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:mycluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis parameter is required for services that do not support service-linked\u003cbr/\u003eroles (such as Amazon EMR), and it must specify the ARN of an IAM role that\u003cbr/\u003eallows Application Auto Scaling to modify the scalable target on your behalf.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service supports service-linked roles, Application Auto Scaling uses\u003cbr/\u003ea service-linked role, which it creates if it does not yet exist. For more\u003cbr/\u003einformation, see Application Auto Scaling IAM roles (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalableDimension\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scalable dimension associated with the scalable target. This string consists\u003cbr/\u003eof the service namespace, resource type, and scaling property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ecs:service:DesiredCount - The desired task count of an ECS service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticmapreduce:instancegroup:InstanceCount - The instance count of\u003cbr/\u003e an EMR Instance Group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot\u003cbr/\u003e Fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream\u003cbr/\u003e 2.0 fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora\u003cbr/\u003e DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible\u003cbr/\u003e edition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances\u003cbr/\u003e for an SageMaker model endpoint variant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-resource:ResourceType:Property - The scalable dimension for a\u003cbr/\u003e custom resource provided by your own application or service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The\u003cbr/\u003e number of inference units for an Amazon Comprehend document classification\u003cbr/\u003e endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number\u003cbr/\u003e of inference units for an Amazon Comprehend entity recognizer endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda:function:ProvisionedConcurrency - The provisioned concurrency\u003cbr/\u003e for a Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:WriteCapacityUnits - The provisioned write capacity\u003cbr/\u003e for an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)\u003cbr/\u003e for brokers in an Amazon MSK cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:NodeGroups - The number of node groups\u003cbr/\u003e for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:Replicas - The number of replicas per\u003cbr/\u003e node group for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * neptune:cluster:ReadReplicaCount - The count of read replicas in an\u003cbr/\u003e Amazon Neptune DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceNamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace of the Amazon Web Services service that provides the resource.\u003cbr/\u003eFor a resource provided by your own application or service, use custom-resource\u003cbr/\u003einstead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn embedded object that contains attributes and attribute values that are\u003cbr/\u003eused to suspend and resume automatic scaling. Setting the value of an attribute\u003cbr/\u003eto true suspends the specified scaling activities. Setting it to false (default)\u003cbr/\u003eresumes the specified scaling activities.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSuspension Outcomes\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For DynamicScalingInSuspended, while a suspension is in effect, all\u003cbr/\u003e scale-in activities that are triggered by a scaling policy are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For DynamicScalingOutSuspended, while a suspension is in effect, all\u003cbr/\u003e scale-out activities that are triggered by a scaling policy are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For ScheduledScalingSuspended, while a suspension is in effect, all\u003cbr/\u003e scaling activities that involve scheduled actions are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Suspending and resuming scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html)\u003cbr/\u003ein the Application Auto Scaling User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.dynamicScalingInSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.dynamicScalingOutSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.scheduledScalingSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scalable target was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scalable target was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:164,href:"https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalingpolicy/",title:"ScalingPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003eapplicationautoscaling.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/applicationautoscaling-controller/apis/v1alpha1#ScalingPolicy"\u003eapplicationautoscaling-controller/apis/v1alpha1#ScalingPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalingPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalingPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalingpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalingpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a scaling policy to use with Application Auto Scaling.\u003c/p\u003e\n\u003cp\u003eFor more information about configuring scaling policies for a specific service,\nsee Getting started with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html)\nin the Application Auto Scaling User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003epolicyName: string\npolicyType: string\nresourceID: string\nscalableDimension: string\nserviceNamespace: string\nstepScalingPolicyConfiguration: \n adjustmentType: string\n cooldown: integer\n metricAggregationType: string\n minAdjustmentMagnitude: integer\n stepAdjustments:\n - metricIntervalLowerBound: number\n metricIntervalUpperBound: number\n scalingAdjustment: integer\ntargetTrackingScalingPolicyConfiguration: \n customizedMetricSpecification: \n dimensions:\n - name: string\n value: string\n metricName: string\n namespace: string\n statistic: string\n unit: string\n disableScaleIn: boolean\n predefinedMetricSpecification: \n predefinedMetricType: string\n resourceLabel: string\n scaleInCooldown: integer\n scaleOutCooldown: integer\n targetValue: number\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe policy type. This parameter is required if you are creating a scaling\u003cbr/\u003epolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following policy types are supported:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTargetTrackingScaling—Not supported for Amazon EMR\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon\u003cbr/\u003eKeyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html)\u003cbr/\u003eand Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html)\u003cbr/\u003ein the Application Auto Scaling User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the resource associated with the scaling policy. This string\u003cbr/\u003econsists of the resource type and unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ECS service - The resource type is service and the unique identifier\u003cbr/\u003e is the cluster name and service name. Example: service/default/sample-webapp.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Spot Fleet - The resource type is spot-fleet-request and the unique\u003cbr/\u003e identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * EMR cluster - The resource type is instancegroup and the unique identifier\u003cbr/\u003e is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AppStream 2.0 fleet - The resource type is fleet and the unique identifier\u003cbr/\u003e is the fleet name. Example: fleet/sample-fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: table/my-table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB global secondary index - The resource type is index and the\u003cbr/\u003e unique identifier is the index name. Example: table/my-table/index/my-table-index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora DB cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:my-db-cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SageMaker endpoint variant - The resource type is variant and the unique\u003cbr/\u003e identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Custom resources are not supported with a resource type. This parameter\u003cbr/\u003e must specify the OutputValue from the CloudFormation template stack used\u003cbr/\u003e to access the resources. The unique identifier is defined by the service\u003cbr/\u003e provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend document classification endpoint - The resource type\u003cbr/\u003e and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend entity recognizer endpoint - The resource type and\u003cbr/\u003e unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Lambda provisioned concurrency - The resource type is function and the\u003cbr/\u003e unique identifier is the function name with a function version or alias\u003cbr/\u003e name suffix that is not $LATEST. Example: function:my-function:prod or\u003cbr/\u003e function:my-function:1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Keyspaces table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: keyspace/mykeyspace/table/mytable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MSK cluster - The resource type and unique identifier are specified\u003cbr/\u003e using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ElastiCache replication group - The resource type is replication-group\u003cbr/\u003e and the unique identifier is the replication group name. Example: replication-group/mycluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Neptune cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:mycluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalableDimension\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scalable dimension. This string consists of the service namespace, resource\u003cbr/\u003etype, and scaling property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ecs:service:DesiredCount - The desired task count of an ECS service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticmapreduce:instancegroup:InstanceCount - The instance count of\u003cbr/\u003e an EMR Instance Group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot\u003cbr/\u003e Fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream\u003cbr/\u003e 2.0 fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora\u003cbr/\u003e DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible\u003cbr/\u003e edition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances\u003cbr/\u003e for an SageMaker model endpoint variant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-resource:ResourceType:Property - The scalable dimension for a\u003cbr/\u003e custom resource provided by your own application or service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The\u003cbr/\u003e number of inference units for an Amazon Comprehend document classification\u003cbr/\u003e endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number\u003cbr/\u003e of inference units for an Amazon Comprehend entity recognizer endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda:function:ProvisionedConcurrency - The provisioned concurrency\u003cbr/\u003e for a Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:WriteCapacityUnits - The provisioned write capacity\u003cbr/\u003e for an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)\u003cbr/\u003e for brokers in an Amazon MSK cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:NodeGroups - The number of node groups\u003cbr/\u003e for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:Replicas - The number of replicas per\u003cbr/\u003e node group for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * neptune:cluster:ReadReplicaCount - The count of read replicas in an\u003cbr/\u003e Amazon Neptune DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceNamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace of the Amazon Web Services service that provides the resource.\u003cbr/\u003eFor a resource provided by your own application or service, use custom-resource\u003cbr/\u003einstead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA step scaling policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required if you are creating a policy and the policy type\u003cbr/\u003eis StepScaling.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.adjustmentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.cooldown\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.metricAggregationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.minAdjustmentMagnitude\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a step adjustment for a StepScalingPolicyConfiguration (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDescribes an adjustment based on the difference between the value of the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaggregated CloudWatch metric and the breach threshold that you\u0026rsquo;ve defined\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor the alarm.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor the following examples, suppose that you have an alarm with a breach\nthreshold of 50:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eTo trigger the adjustment when the metric is greater than or equal to\n50 and less than 60, specify a lower bound of 0 and an upper bound of\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="10"\u003e\n\u003cli\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eTo trigger the adjustment when the metric is greater than 40 and less\nthan or equal to 50, specify a lower bound of -10 and an upper bound of\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="0"\u003e\n\u003cli\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eThere are a few rules for the step adjustments for your step policy:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe ranges of your step adjustments can\u0026rsquo;t overlap or have a gap.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAt most one step adjustment can have a null lower bound. If one step\nadjustment has a negative lower bound, then there must be a step adjustment\nwith a null lower bound.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAt most one step adjustment can have a null upper bound. If one step\nadjustment has a positive upper bound, then there must be a step adjustment\nwith a null upper bound.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe upper and lower bound can\u0026rsquo;t be null in the same step adjustment. || \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalLowerBound\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalUpperBound\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].scalingAdjustment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA target tracking scaling policy. Includes support for predefined or customized\u003cbr/\u003emetrics.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required if you are creating a policy and the policy type\u003cbr/\u003eis TargetTrackingScaling. |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CloudWatch metric of your choosing for a target tracking scaling\u003cbr/\u003epolicy to use with Application Auto Scaling.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about the available metrics for a service, see Amazon Web\u003cbr/\u003eServices Services That Publish CloudWatch Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)\u003cbr/\u003ein the Amazon CloudWatch User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create your customized metric specification:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Add values for each required parameter from CloudWatch. You can use\u003cbr/\u003e an existing metric, or a new metric that you create. To use your own metric,\u003cbr/\u003e you must first publish the metric to CloudWatch. For more information,\u003cbr/\u003e see Publish Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)\u003cbr/\u003e in the Amazon CloudWatch User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Choose a metric that changes proportionally with capacity. The value\u003cbr/\u003e of the metric should increase or decrease in inverse proportion to the\u003cbr/\u003e number of capacity units. That is, the value of the metric should decrease\u003cbr/\u003e when capacity increases, and increase when capacity decreases.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the dimension names and values associated with a metric. || \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.statistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.disableScaleIn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a predefined metric for a target tracking scaling policy to use\u003cbr/\u003ewith Application Auto Scaling.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnly the Amazon Web Services that you\u0026rsquo;re using send metrics to Amazon CloudWatch.\u003cbr/\u003eTo determine whether a desired metric already exists by looking up its namespace\u003cbr/\u003eand dimension using the CloudWatch metrics dashboard in the console, follow\u003cbr/\u003ethe procedure in Building dashboards with CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html)\u003cbr/\u003ein the Application Auto Scaling User Guide. |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.predefinedMetricType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.resourceLabel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.scaleInCooldown\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.scaleOutCooldown\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.targetValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nalarms:\n- alarmARN: string\n alarmName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe CloudWatch alarms created for the target tracking scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CloudWatch alarm associated with a scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms.[].alarmName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scaling policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scaling policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:165,href:"https://aws-controllers-k8s.github.io/community/reference/secretsmanager/v1alpha1/secret/",title:"Secret",description:null,content:'\u003cp\u003e\u003ccode\u003esecretsmanager.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/secretsmanager-controller/apis/v1alpha1#Secret"\u003esecretsmanager-controller/apis/v1alpha1#Secret\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecret\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecretList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecrets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecret\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nforceOverwriteReplicaSecret: boolean\nkmsKeyID: string\nname: string\nreplicaRegions:\n- kmsKeyID: string\n region: string\nsecretString: \n key: string\n name: string\n namespace: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eforceOverwriteReplicaSecret\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to overwrite a secret with the same name in the destination\u003cbr/\u003eRegion. By default, secrets aren\u0026rsquo;t overwritten.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt\u003cbr/\u003ethe secret value in the secret. An alias is always prefixed by alias/, for\u003cbr/\u003eexample alias/aws/secretsmanager. For more information, see About aliases\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a KMS key in a different account, use the key ARN or the alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify this value, then Secrets Manager uses the key aws/secretsmanager.\u003cbr/\u003eIf that key doesn\u0026rsquo;t yet exist, then Secrets Manager creates it for you automatically\u003cbr/\u003ethe first time it encrypts the secret value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the secret is in a different Amazon Web Services account from the credentials\u003cbr/\u003ecalling the API, then you can\u0026rsquo;t use aws/secretsmanager to encrypt the secret,\u003cbr/\u003eand you must create and use a customer managed KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new secret.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe secret name can contain ASCII letters, numbers, and the following characters:\u003cbr/\u003e/_+=.@-\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDo not end your secret name with a hyphen followed by six characters. If\u003cbr/\u003eyou do so, you risk confusion and unexpected results when searching for a\u003cbr/\u003esecret by partial ARN. Secrets Manager automatically adds a hyphen and six\u003cbr/\u003erandom characters after the secret name at the end of the ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Regions and KMS keys to replicate secrets.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom type that specifies a Region and the KmsKeyId for a replica secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe text data to encrypt and store in this new version of the secret. We\u003cbr/\u003erecommend you use a JSON structure of key/value pairs for your secret value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEither SecretString or SecretBinary must have a value, but not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create a secret by using the Secrets Manager console then Secrets\u003cbr/\u003eManager puts the protected secret text in only the SecretString parameter.\u003cbr/\u003eThe Secrets Manager console stores the information as a JSON structure of\u003cbr/\u003ekey/value pairs that a Lambda rotation function can parse.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to attach to the secret. Each tag is a key and value pair\u003cbr/\u003eof strings in a JSON text string, for example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e[{\u0026ldquo;Key\u0026rdquo;:\u0026ldquo;CostCenter\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026ldquo;12345\u0026rdquo;},{\u0026ldquo;Key\u0026rdquo;:\u0026ldquo;environment\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026ldquo;production\u0026rdquo;}]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSecrets Manager tag key names are case sensitive. A tag with the key \u0026ldquo;ABC\u0026rdquo;\u003cbr/\u003eis a different tag from one with key \u0026ldquo;abc\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you check tags in permissions policies as part of your security strategy,\u003cbr/\u003ethen adding or removing a tag can change permissions. If the completion of\u003cbr/\u003ethis operation would result in you losing your permissions for this secret,\u003cbr/\u003ethen Secrets Manager blocks the operation and returns an Access Denied error.\u003cbr/\u003eFor more information, see Control access to secrets using tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac)\u003cbr/\u003eand Limit access to identities with tags that match secrets\' tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about how to format a JSON parameter for the various command\u003cbr/\u003eline tool environments, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json).\u003cbr/\u003eIf your command-line tool or SDK requires quotation marks around the parameter,\u003cbr/\u003eyou should use single quotes to avoid confusion with the double quotes required\u003cbr/\u003ein the JSON text.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tag quotas and naming restrictions, see Service quotas for Tagging (https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas)\u003cbr/\u003ein the Amazon Web Services General Reference guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that contains information about a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nreplicationStatus:\n- kmsKeyID: string\n lastAccessedDate: string\n region: string\n status: string\n statusMessage: string\nversionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the replicas of this secret and their status:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed, which indicates that the replica was not created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InProgress, which indicates that Secrets Manager is in the process of\u003cbr/\u003e creating the replica.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InSync, which indicates that the replica was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA replication object consisting of a RegionReplicationStatus object and includes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea Region, KMSKeyId, status, and status message.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].lastAccessedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier associated with the version of the new secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:166,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/securitygroup/",title:"SecurityGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#SecurityGroup"\u003eec2-controller/apis/v1alpha1#SecurityGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecurityGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecurityGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecuritygroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecuritygroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a security group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\negressRules:\n- fromPort: integer\n ipProtocol: string\n ipRanges:\n - cidrIP: string\n description: string\n ipv6Ranges:\n - cidrIPv6: string\n description: string\n prefixListIDs:\n - description: string\n prefixListID: string\n toPort: integer\n userIDGroupPairs:\n - description: string\n groupID: string\n groupName: string\n peeringStatus: string\n userID: string\n vpcID: string\n vpcPeeringConnectionID: string\ningressRules:\n- fromPort: integer\n ipProtocol: string\n ipRanges:\n - cidrIP: string\n description: string\n ipv6Ranges:\n - cidrIPv6: string\n description: string\n prefixListIDs:\n - description: string\n prefixListID: string\n toPort: integer\n userIDGroupPairs:\n - description: string\n groupID: string\n groupName: string\n peeringStatus: string\n userID: string\n vpcID: string\n vpcPeeringConnectionID: string\nname: string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the security group. This is informational only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Up to 255 characters in length\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-Classic: ASCII characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a set of permissions for a security group rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC only] Describes an IPv6 range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a prefix list ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].userIDGroupPairs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].userIDGroupPairs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group and Amazon Web Services account ID pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\nfrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\nto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\nin the Amazon Elastic Compute Cloud User Guide. || \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].groupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].peeringStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].userID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a set of permissions for a security group rule. || \u003cstrong\u003eingressRules.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 range. || \u003cstrong\u003eingressRules.[].ipRanges.[].cidrIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC only] Describes an IPv6 range. || \u003cstrong\u003eingressRules.[].ipv6Ranges.[].cidrIPv6\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a prefix list ID. || \u003cstrong\u003eingressRules.[].prefixListIDs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group and Amazon Web Services account ID pair.\u003c/p\u003e\n\u003cp\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\nfrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\nto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\nin the Amazon Elastic Compute Cloud User Guide. || \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].groupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].peeringStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].userID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the security group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Up to 255 characters in length. Cannot start with sg-.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-Classic: ASCII characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$* |\n| **tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| **tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDescribes a tag. || **tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **vpcID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e[EC2-VPC] The ID of the VPC. Required for EC2-VPC. |\n| **vpcRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **vpcRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **vpcRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nrules:\n- cidrIPv4: string\n cidrIPv6: string\n description: string\n fromPort: integer\n ipProtocol: string\n isEgress: boolean\n prefixListID: string\n securityGroupRuleID: string\n tags:\n - key: string\n value: string\n toPort: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the security group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about security group rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].cidrIPv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].isEgress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].securityGroupRuleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:167,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/service/",title:"Service",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#Service"\u003eecs-controller/apis/v1alpha1#Service\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eService\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eServiceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eservices\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eservice\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails on a service within a cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacityProviderStrategy:\n- base: integer\n capacityProvider: string\n weight: integer\ncluster: string\nclusterRef: \n from: \n name: string\ndeploymentConfiguration: \n alarms: \n alarmNames:\n - string\n enable: boolean\n rollback: boolean\n deploymentCircuitBreaker: \n enable: boolean\n rollback: boolean\n maximumPercent: integer\n minimumHealthyPercent: integer\ndeploymentController: \n type: string\ndesiredCount: integer\nenableECSManagedTags: boolean\nenableExecuteCommand: boolean\nhealthCheckGracePeriodSeconds: integer\nlaunchType: string\nloadBalancers:\n- containerName: string\n containerPort: integer\n loadBalancerName: string\n targetGroupARN: string\nname: string\nnetworkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\nplacementConstraints:\n- expression: string\n type: string\nplacementStrategy:\n- field: string\n type: string\nplatformVersion: string\npropagateTags: string\nrole: string\nroleRef: \n from: \n name: string\nschedulingStrategy: string\nserviceConnectConfiguration: \n enabled: boolean\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n namespace: string\n services:\n clientAliases:\n - dnsName: string\n port: integer\n discoveryName: string\n ingressPortOverride: integer\n portName: string\n timeout: \n idleTimeoutSeconds: integer\n perRequestTimeoutSeconds: integer\n tls: \n issuerCertificateAuthority: \n awsPCAAuthorityARN: string\n kmsKey: string\n roleARN: string\nserviceRegistries:\n- containerName: string\n containerPort: integer\n port: integer\n registryARN: string\ntags:\n- key: string\n value: string\ntaskDefinition: string\ntaskDefinitionRef: \n from: \n name: string\nvolumeConfigurations:\n managedEBSVolume: \n encrypted: boolean\n filesystemType: string\n iops: integer\n kmsKeyID: string\n roleARN: string\n sizeInGiB: integer\n snapshotID: string\n tagSpecifications:\n - propagateTags: string\n resourceType: string\n tags:\n - key: string\n value: string\n throughput: integer\n volumeType: string\n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe capacity provider strategy to use for the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a capacityProviderStrategy is specified, the launchType parameter must\u003cbr/\u003ebe omitted. If no capacityProviderStrategy or launchType is specified, the\u003cbr/\u003edefaultCapacityProviderStrategy for the cluster is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA capacity provider strategy may contain a maximum of 6 capacity providers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003ecapacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecapacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecapacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecluster\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe short name or full Amazon Resource Name (ARN) of the cluster that you\u003cbr/\u003erun your service on. If you do not specify a cluster, the default cluster\u003cbr/\u003eis assumed. |\n| \u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional deployment parameters that control how many tasks run during the\u003cbr/\u003edeployment and the ordering of stopping and starting tasks. |\n| \u003cstrong\u003edeploymentConfiguration.alarms\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne of the methods which provide a way for you to quickly identify when a\u003cbr/\u003edeployment has failed, and then to optionally roll back the failure to the\u003cbr/\u003elast working deployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the alarms are generated, Amazon ECS sets the service deployment to\u003cbr/\u003efailed. Set the rollback parameter to have Amazon ECS to roll back your service\u003cbr/\u003eto the last completed deployment after a failure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can only use the DeploymentAlarms method to detect failures when the\u003cbr/\u003eDeploymentController is set to ECS (rolling update).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide . |\n| \u003cstrong\u003edeploymentConfiguration.alarms.alarmNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.alarms.alarmNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeploymentConfiguration.alarms.enable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.alarms.rollback\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment circuit breaker can only be used for services using the rolling\u003cbr/\u003eupdate (ECS) deployment type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe deployment circuit breaker determines whether a service deployment will\u003cbr/\u003efail if the service can\u0026rsquo;t reach a steady state. If it is turned on, a service\u003cbr/\u003edeployment will transition to a failed state and stop launching new tasks.\u003cbr/\u003eYou can also configure Amazon ECS to roll back your service to the last completed\u003cbr/\u003edeployment after a failure. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about API failure reasons, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker.enable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker.rollback\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.maximumPercent\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.minimumHealthyPercent\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentController\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment controller to use for the service. If no deployment controller\u003cbr/\u003eis specified, the default value of ECS is used. |\n| \u003cstrong\u003edeploymentController.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edesiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of instantiations of the specified task definition to place and\u003cbr/\u003ekeep running in your service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis is required if schedulingStrategy is REPLICA or isn\u0026rsquo;t specified. If\u003cbr/\u003eschedulingStrategy is DAEMON then this isn\u0026rsquo;t required. |\n| \u003cstrong\u003eenableECSManagedTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to turn on Amazon ECS managed tags for the tasks within\u003cbr/\u003ethe service. For more information, see Tagging your Amazon ECS resources\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you use Amazon ECS managed tags, you need to set the propagateTags request\u003cbr/\u003eparameter. |\n| \u003cstrong\u003eenableExecuteCommand\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eDetermines whether the execute command functionality is turned on for the\u003cbr/\u003eservice. If true, this enables execute command functionality on all containers\u003cbr/\u003ein the service tasks. |\n| \u003cstrong\u003ehealthCheckGracePeriodSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe period of time, in seconds, that the Amazon ECS service scheduler ignores\u003cbr/\u003eunhealthy Elastic Load Balancing target health checks after a task has first\u003cbr/\u003estarted. This is only used when your service is configured to use a load\u003cbr/\u003ebalancer. If your service has a load balancer defined and you don\u0026rsquo;t specify\u003cbr/\u003ea health check grace period value, the default value of 0 is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not use an Elastic Load Balancing, we recommend that you use the\u003cbr/\u003estartPeriod in the task definition health check parameters. For more information,\u003cbr/\u003esee Health check (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your service\u0026rsquo;s tasks take a while to start and respond to Elastic Load\u003cbr/\u003eBalancing health checks, you can specify a health check grace period of up\u003cbr/\u003eto 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS\u003cbr/\u003eservice scheduler ignores health check status. This grace period can prevent\u003cbr/\u003ethe service scheduler from marking tasks as unhealthy and stopping them before\u003cbr/\u003ethey have time to come up. |\n| \u003cstrong\u003elaunchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe infrastructure that you run your service on. For more information, see\u003cbr/\u003eAmazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFargate Spot infrastructure is available for use but a capacity provider\u003cbr/\u003estrategy must be used. For more information, see Fargate capacity providers\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html)\u003cbr/\u003ein the Amazon ECS User Guide for Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe EC2 launch type runs your tasks on Amazon EC2 instances registered to\u003cbr/\u003eyour cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe EXTERNAL launch type runs your tasks on your on-premises server or virtual\u003cbr/\u003emachine (VM) capacity registered to your cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA service can use either a launch type or a capacity provider strategy. If\u003cbr/\u003ea launchType is specified, the capacityProviderStrategy parameter must be\u003cbr/\u003eomitted. |\n| \u003cstrong\u003eloadBalancers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA load balancer object representing the load balancers to use with your service.\u003cbr/\u003eFor more information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service uses the rolling update (ECS) deployment controller and using\u003cbr/\u003eeither an Application Load Balancer or Network Load Balancer, you must specify\u003cbr/\u003eone or more target group ARNs to attach to the service. The service-linked\u003cbr/\u003erole is required for services that use multiple target groups. For more information,\u003cbr/\u003esee Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service uses the CODE_DEPLOY deployment controller, the service is\u003cbr/\u003erequired to use either an Application Load Balancer or Network Load Balancer.\u003cbr/\u003eWhen creating an CodeDeploy deployment group, you specify two target groups\u003cbr/\u003e(referred to as a targetGroupPair). During a deployment, CodeDeploy determines\u003cbr/\u003ewhich task set in your service has the status PRIMARY, and it associates\u003cbr/\u003eone target group with it. Then, it also associates the other target group\u003cbr/\u003ewith the replacement task set. The load balancer can also have up to two\u003cbr/\u003elisteners: a required listener for production traffic and an optional listener\u003cbr/\u003ethat you can use to perform validation tests with Lambda functions before\u003cbr/\u003erouting production traffic to it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use the CODE_DEPLOY deployment controller, these values can be changed\u003cbr/\u003ewhen updating the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Application Load Balancers and Network Load Balancers, this object must\u003cbr/\u003econtain the load balancer target group ARN, the container name, and the container\u003cbr/\u003eport to access from the load balancer. The container name must be as it appears\u003cbr/\u003ein a container definition. The load balancer name parameter must be omitted.\u003cbr/\u003eWhen a task from this service is placed on a container instance, the container\u003cbr/\u003einstance and port combination is registered as a target in the target group\u003cbr/\u003ethat\u0026rsquo;s specified here.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Classic Load Balancers, this object must contain the load balancer name,\u003cbr/\u003ethe container name , and the container port to access from the load balancer.\u003cbr/\u003eThe container name must be as it appears in a container definition. The target\u003cbr/\u003egroup ARN parameter must be omitted. When a task from this service is placed\u003cbr/\u003eon a container instance, the container instance is registered with the load\u003cbr/\u003ebalancer that\u0026rsquo;s specified here.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eServices with tasks that use the awsvpc network mode (for example, those\u003cbr/\u003ewith the Fargate launch type) only support Application Load Balancers and\u003cbr/\u003eNetwork Load Balancers. Classic Load Balancers aren\u0026rsquo;t supported. Also, when\u003cbr/\u003eyou create any target groups for these services, you must choose ip as the\u003cbr/\u003etarget type, not instance. This is because tasks that use the awsvpc network\u003cbr/\u003emode are associated with an elastic network interface, not an Amazon EC2\u003cbr/\u003einstance. |\n| \u003cstrong\u003eloadBalancers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe load balancer configuration to use with a service or task set.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove a load balancer configuration, Amazon ECS\nstarts a new deployment with the updated Elastic Load Balancing configuration.\nThis causes tasks to register to and deregister from load balancers.\u003c/p\u003e\n\u003cp\u003eWe recommend that you verify this on a test environment before you update\nthe Elastic Load Balancing configuration.\u003c/p\u003e\n\u003cp\u003eA service-linked role is required for services that use multiple target groups.\nFor more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eloadBalancers.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].loadBalancerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].targetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your service. Up to 255 letters (uppercase and lowercase), numbers,\u003cbr/\u003eunderscores, and hyphens are allowed. Service names must be unique within\u003cbr/\u003ea cluster, but you can have similarly named services in multiple clusters\u003cbr/\u003ewithin a Region or across multiple Regions. |\n| \u003cstrong\u003enetworkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for the service. This parameter is required for\u003cbr/\u003etask definitions that use the awsvpc network mode to receive their own elastic\u003cbr/\u003enetwork interface, and it isn\u0026rsquo;t supported for other network modes. For more\u003cbr/\u003einformation, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eplacementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of placement constraint objects to use for tasks in your service.\u003cbr/\u003eYou can specify a maximum of 10 constraints for each task. This limit includes\u003cbr/\u003econstraints in the task definition and those specified at runtime. |\n| \u003cstrong\u003eplacementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a constraint on task placement. For more information,\nsee Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re using the Fargate launch type, task placement constraints aren\u0026rsquo;t\nsupported. || \u003cstrong\u003eplacementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementConstraints.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe placement strategy objects to use for tasks in your service. You can\u003cbr/\u003especify a maximum of 5 strategy rules for each service. |\n| \u003cstrong\u003eplacementStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe task placement strategy for a task or service. For more information,\nsee Task placement strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eplacementStrategy.[].field\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementStrategy.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplatformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform version that your tasks in the service are running on. A platform\u003cbr/\u003eversion is specified only for tasks using the Fargate launch type. If one\u003cbr/\u003eisn\u0026rsquo;t specified, the LATEST platform version is used. For more information,\u003cbr/\u003esee Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003epropagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to propagate the tags from the task definition to the task.\u003cbr/\u003eIf no value is specified, the tags aren\u0026rsquo;t propagated. Tags can only be propagated\u003cbr/\u003eto the task during task creation. To add tags to a task after task creation,\u003cbr/\u003euse the TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html)\u003cbr/\u003eAPI action.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is NONE. |\n| \u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon\u003cbr/\u003eECS to make calls to your load balancer on your behalf. This parameter is\u003cbr/\u003eonly permitted if you are using a load balancer with your service and your\u003cbr/\u003etask definition doesn\u0026rsquo;t use the awsvpc network mode. If you specify the role\u003cbr/\u003eparameter, you must also specify a load balancer object with the loadBalancers\u003cbr/\u003eparameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your account has already created the Amazon ECS service-linked role, that\u003cbr/\u003erole is used for your service unless you specify a role here. The service-linked\u003cbr/\u003erole is required if your task definition uses the awsvpc network mode or\u003cbr/\u003eif the service is configured to use service discovery, an external deployment\u003cbr/\u003econtroller, multiple target groups, or Elastic Inference accelerators in\u003cbr/\u003ewhich case you don\u0026rsquo;t specify a role here. For more information, see Using\u003cbr/\u003eservice-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your specified role has a path other than /, then you must either specify\u003cbr/\u003ethe full role ARN (this is recommended) or prefix the role name with the\u003cbr/\u003epath. For example, if a role with the name bar has a path of /foo/ then you\u003cbr/\u003ewould specify /foo/bar as the role name. For more information, see Friendly\u003cbr/\u003enames and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names)\u003cbr/\u003ein the IAM User Guide. |\n| \u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eschedulingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scheduling strategy to use for the service. For more information, see\u003cbr/\u003eServices (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere are two service scheduler strategies available:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * REPLICA-The replica scheduling strategy places and maintains the desired\u003cbr/\u003e number of tasks across your cluster. By default, the service scheduler\u003cbr/\u003e spreads tasks across Availability Zones. You can use task placement strategies\u003cbr/\u003e and constraints to customize task placement decisions. This scheduler\u003cbr/\u003e strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment\u003cbr/\u003e controller types.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DAEMON-The daemon scheduling strategy deploys exactly one task on each\u003cbr/\u003e active container instance that meets all of the task placement constraints\u003cbr/\u003e that you specify in your cluster. The service scheduler also evaluates\u003cbr/\u003e the task placement constraints for running tasks and will stop tasks that\u003cbr/\u003e don\u0026rsquo;t meet the placement constraints. When you\u0026rsquo;re using this strategy,\u003cbr/\u003e you don\u0026rsquo;t need to specify a desired number of tasks, a task placement\u003cbr/\u003e strategy, or use Service Auto Scaling policies. Tasks using the Fargate\u003cbr/\u003e launch type or the CODE_DEPLOY or EXTERNAL deployment controller types\u003cbr/\u003e don\u0026rsquo;t support the DAEMON scheduling strategy. |\n| \u003cstrong\u003eserviceConnectConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for this service to discover and connect to services, and\u003cbr/\u003ebe discovered by, and connected from, other services within a namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eserviceConnectConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect service object configuration. For more information, see\nService Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEach alias (\u0026ldquo;endpoint\u0026rdquo;) is a fully-qualified name and port number that other\ntasks (\u0026ldquo;clients\u0026rdquo;) can use to connect to this service.\u003c/p\u003e\n\u003cp\u003eEach name and port mapping must be unique within the namespace.\u003c/p\u003e\n\u003cp\u003eTasks that run in a namespace can use short names to connect to services\nin the namespace. Tasks can connect to services across all of the clusters\nin the namespace. Tasks connect through a managed proxy container that collects\nlogs and metrics for increased visibility. Only the tasks that Amazon ECS\nservices create are supported with Service Connect. For more information,\nsee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].ingressPortOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].portName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the timeout configurations for Service Connect.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf idleTimeout is set to a time that is less than perRequestTimeout, the\u003cbr/\u003econnection will close when the idleTimeout is reached and not the perRequestTimeout. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout.idleTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout.perRequestTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the configuration for Service Connect TLS. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.issuerCertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the Amazon Web Services Private Certificate Authority\u003cbr/\u003ecertificate. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.issuerCertificateAuthority.awsPCAAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe details of the service discovery registry to associate with this service.\u003cbr/\u003eFor more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach service may be associated with one service registry. Multiple service\u003cbr/\u003eregistries for each service isn\u0026rsquo;t supported. |\n| \u003cstrong\u003eserviceRegistries.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for the service registry.\u003c/p\u003e\n\u003cp\u003eEach service may be associated with one service registry. Multiple service\nregistries for each service are not supported.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove the service registries configuration, Amazon\nECS starts a new deployment. New tasks are registered and deregistered to\nthe updated service registry configuration. || \u003cstrong\u003eserviceRegistries.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].registryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the service to help you categorize and organize\u003cbr/\u003ethem. Each tag consists of a key and an optional value, both of which you\u003cbr/\u003edefine. When a service is deleted, the tags are deleted as well.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe family and revision (family:revision) or full ARN of the task definition\u003cbr/\u003eto run in your service. If a revision isn\u0026rsquo;t specified, the latest ACTIVE\u003cbr/\u003erevision is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA task definition must be specified if the service uses either the ECS or\u003cbr/\u003eCODE_DEPLOY deployment controllers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about deployment types, see Amazon ECS deployment types\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). |\n| \u003cstrong\u003etaskDefinitionRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003etaskDefinitionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003etaskDefinitionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\u003cbr/\u003ethat is configured at launch time. Currently, the only supported volume type\u003cbr/\u003eis an Amazon EBS volume. |\n| \u003cstrong\u003evolumeConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\nthat is configured at launch time. Currently, the only supported volume type\nis an Amazon EBS volume. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for the Amazon EBS volume that Amazon ECS creates and manages\u003cbr/\u003eon your behalf. These settings are used to create each Amazon EBS volume,\u003cbr/\u003ewith one volume created for each task in the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\u003cbr/\u003eparameters. |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.filesystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tag specifications of an Amazon EBS volume. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].propagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].resourceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.throughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusterARN: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\ncreatedBy: string\ndeployments:\n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n createdAt: string\n desiredCount: integer\n failedTasks: integer\n id: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n pendingCount: integer\n platformFamily: string\n platformVersion: string\n rolloutState: string\n rolloutStateReason: string\n runningCount: integer\n serviceConnectConfiguration: \n enabled: boolean\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n namespace: string\n services:\n clientAliases:\n - dnsName: string\n port: integer\n discoveryName: string\n ingressPortOverride: integer\n portName: string\n timeout: \n idleTimeoutSeconds: integer\n perRequestTimeoutSeconds: integer\n tls: \n issuerCertificateAuthority: \n awsPCAAuthorityARN: string\n kmsKey: string\n roleARN: string\n serviceConnectResources:\n - discoveryARN: string\n discoveryName: string\n status: string\n taskDefinition: string\n updatedAt: string\n volumeConfigurations:\n managedEBSVolume: \n encrypted: boolean\n filesystemType: string\n iops: integer\n kmsKeyID: string\n roleARN: string\n sizeInGiB: integer\n snapshotID: string\n tagSpecifications:\n - propagateTags: string\n resourceType: string\n tags:\n - key: string\n value: string\n throughput: integer\n volumeType: string\n name: string\nevents:\n- createdAt: string\n id: string\n message: string\npendingCount: integer\nplatformFamily: string\nroleARN: string\nrunningCount: integer\nstatus: string\ntaskSets:\n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n clusterARN: string\n computedDesiredCount: integer\n createdAt: string\n externalID: string\n id: string\n launchType: string\n loadBalancers:\n - containerName: string\n containerPort: integer\n loadBalancerName: string\n targetGroupARN: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n pendingCount: integer\n platformFamily: string\n platformVersion: string\n runningCount: integer\n scale: \n unit: string\n value: number\n serviceARN: string\n serviceRegistries:\n - containerName: string\n containerPort: integer\n port: integer\n registryARN: string\n stabilityStatus: string\n stabilityStatusAt: string\n startedBy: string\n status: string\n tags:\n - key: string\n value: string\n taskDefinition: string\n taskSetARN: string\n updatedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the cluster that hosts the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the service was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe principal that created the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe current state of deployments for the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of an Amazon ECS service deployment. This is used only when a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice uses the ECS deployment controller type.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments.[].capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].desiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].failedTasks\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for a task or service. |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeployments.[].pendingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].platformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].platformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].rolloutState\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].rolloutStateReason\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].runningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect configuration of your Amazon ECS service. The configuration\u003cbr/\u003efor this service to discover and connect to services, and be discovered by,\u003cbr/\u003eand connected from, other services within a namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect service object configuration. For more information, see\nService Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEach alias (\u0026ldquo;endpoint\u0026rdquo;) is a fully-qualified name and port number that other\ntasks (\u0026ldquo;clients\u0026rdquo;) can use to connect to this service.\u003c/p\u003e\n\u003cp\u003eEach name and port mapping must be unique within the namespace.\u003c/p\u003e\n\u003cp\u003eTasks that run in a namespace can use short names to connect to services\nin the namespace. Tasks can connect to services across all of the clusters\nin the namespace. Tasks connect through a managed proxy container that collects\nlogs and metrics for increased visibility. Only the tasks that Amazon ECS\nservices create are supported with Service Connect. For more information,\nsee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].ingressPortOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].portName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the timeout configurations for Service Connect.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf idleTimeout is set to a time that is less than perRequestTimeout, the\u003cbr/\u003econnection will close when the idleTimeout is reached and not the perRequestTimeout. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout.idleTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout.perRequestTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the configuration for Service Connect TLS. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.issuerCertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the Amazon Web Services Private Certificate Authority\u003cbr/\u003ecertificate. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.issuerCertificateAuthority.awsPCAAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect resource. Each configuration maps a discovery name to\na Cloud Map service name. The data is stored in Cloud Map as part of the\nService Connect configuration for each discovery name of this Amazon ECS\nservice.\u003c/p\u003e\n\u003cp\u003eA task can resolve the dnsName for each of the clientAliases of a service.\nHowever a task can\u0026rsquo;t resolve the discovery names. If you want to connect\nto a service, refer to the ServiceConnectConfiguration of that service for\nthe list of clientAliases that you can use. || \u003cstrong\u003edeployments.[].serviceConnectResources.[].discoveryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].taskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\nthat is configured at launch time. Currently, the only supported volume type\nis an Amazon EBS volume. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for the Amazon EBS volume that Amazon ECS creates and manages\u003cbr/\u003eon your behalf. These settings are used to create each Amazon EBS volume,\u003cbr/\u003ewith one volume created for each task in the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\u003cbr/\u003eparameters. |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.filesystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tag specifications of an Amazon EBS volume. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].propagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].resourceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.throughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe event stream for your service. A maximum of 100 of the latest events\u003cbr/\u003eare displayed. |\n| \u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for an event that\u0026rsquo;s associated with a service. || \u003cstrong\u003eevents.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the PENDING state. |\n| \u003cstrong\u003eplatformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe operating system that your tasks in the service run on. A platform family\u003cbr/\u003eis specified only for tasks using the Fargate launch type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll tasks that run as part of this service must use the same platformFamily\u003cbr/\u003evalue as the service (for example, LINUX). |\n| \u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the IAM role that\u0026rsquo;s associated with the service. It allows the\u003cbr/\u003eAmazon ECS container agent to register container instances with an Elastic\u003cbr/\u003eLoad Balancing load balancer. |\n| \u003cstrong\u003erunningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the RUNNING state. |\n| \u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. |\n| \u003cstrong\u003etaskSets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about a set of Amazon ECS tasks in either an CodeDeploy or an\u003cbr/\u003eEXTERNAL deployment. An Amazon ECS task set includes details such as the\u003cbr/\u003edesired number of tasks, how many tasks are running, and whether the task\u003cbr/\u003eset serves production traffic. |\n| \u003cstrong\u003etaskSets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about a set of Amazon ECS tasks in either an CodeDeploy or an\nEXTERNAL deployment. An Amazon ECS task set includes details such as the\ndesired number of tasks, how many tasks are running, and whether the task\nset serves production traffic. || \u003cstrong\u003etaskSets.[].capacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\ncan be set when using the RunTask or CreateCluster APIs or as the default\ncapacity provider strategy for a cluster with the CreateCluster API.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].clusterARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].computedDesiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].externalID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe load balancer configuration to use with a service or task set.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove a load balancer configuration, Amazon ECS\nstarts a new deployment with the updated Elastic Load Balancing configuration.\nThis causes tasks to register to and deregister from load balancers.\u003c/p\u003e\n\u003cp\u003eWe recommend that you verify this on a test environment before you update\nthe Elastic Load Balancing configuration.\u003c/p\u003e\n\u003cp\u003eA service-linked role is required for services that use multiple target groups.\nFor more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003etaskSets.[].loadBalancers.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].loadBalancerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].targetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for a task or service. |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etaskSets.[].pendingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].platformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].platformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].runningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].scale\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA floating-point percentage of the desired number of tasks to place and keep\u003cbr/\u003erunning in the task set. |\n| \u003cstrong\u003etaskSets.[].scale.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].scale.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for the service registry.\u003c/p\u003e\n\u003cp\u003eEach service may be associated with one service registry. Multiple service\nregistries for each service are not supported.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove the service registries configuration, Amazon\nECS starts a new deployment. New tasks are registered and deregistered to\nthe updated service registry configuration. || \u003cstrong\u003etaskSets.[].serviceRegistries.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].registryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].stabilityStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].stabilityStatusAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].startedBy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etaskSets.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].taskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].taskSetARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:168,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/snapshot/",title:"Snapshot",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#Snapshot"\u003eelasticache-controller/apis/v1alpha1#Snapshot\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshotList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshots\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a copy of an entire Redis cluster as of the time when the snapshot was taken.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheClusterID: string\nkmsKeyID: string\nreplicationGroupID: string\nsnapshotName: string\nsourceSnapshotName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of an existing cluster. The snapshot is created from this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of an existing replication group. The snapshot is created from this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the snapshot being created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceSnapshotName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an existing snapshot from which to make a copy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nautoMinorVersionUpgrade: boolean\nautomaticFailover: string\ncacheClusterCreateTime: string\ncacheNodeType: string\ncacheParameterGroupName: string\ncacheSubnetGroupName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndataTiering: string\nengine: string\nengineVersion: string\nnodeSnapshots:\n- cacheClusterID: string\n cacheNodeCreateTime: string\n cacheNodeID: string\n cacheSize: string\n nodeGroupConfiguration: \n nodeGroupID: string\n primaryAvailabilityZone: string\n primaryOutpostARN: string\n replicaAvailabilityZones:\n - string\n replicaCount: integer\n replicaOutpostARNs:\n - string\n slots: string\n nodeGroupID: string\n snapshotCreateTime: string\nnumCacheNodes: integer\nnumNodeGroups: integer\nport: integer\npreferredAvailabilityZone: string\npreferredMaintenanceWindow: string\npreferredOutpostARN: string\nreplicationGroupDescription: string\nsnapshotRetentionLimit: integer\nsnapshotSource: string\nsnapshotStatus: string\nsnapshotWindow: string\ntopicARN: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the status of automatic failover for the source Redis replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheClusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the source cluster was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheNodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the compute and memory capacity node type for the source cluster. \u003cbr/\u003e The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. \u003cbr/\u003e * General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge \u003cbr/\u003e * Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge \u003cbr/\u003e * Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge \u003cbr/\u003e * Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge \u003cbr/\u003e Additional node type info \u003cbr/\u003e * All current generation instance types are created in Amazon VPC by default. \u003cbr/\u003e * Redis append-only files (AOF) are not supported for T1 or T2 instances. \u003cbr/\u003e * Redis Multi-AZ with automatic failover is not supported on T1 instances. \u003cbr/\u003e * Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cache parameter group that is associated with the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache subnet group associated with the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache engine (memcached or redis) used by the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the cache engine version that is used by the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the cache nodes in the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an individual cache node in a snapshot of a cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheNodeCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheNodeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.nodeGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.primaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.primaryOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].snapshotCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumCacheNodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of cache nodes in the source cluster. \u003cbr/\u003e For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumNodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number used by each cache nodes in the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Availability Zone in which the source cluster is located.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. \u003cbr/\u003e Valid values for ddd are: \u003cbr/\u003e * sun \u003cbr/\u003e * mon \u003cbr/\u003e * tue \u003cbr/\u003e * wed \u003cbr/\u003e * thu \u003cbr/\u003e * fri \u003cbr/\u003e * sat \u003cbr/\u003e Example: sun:23:00-mon:01:30\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN (Amazon Resource Name) of the preferred outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the source replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eFor an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. \u003cbr/\u003e For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. \u003cbr/\u003e Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the snapshot. Valid values: creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which ElastiCache takes daily snapshots of the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:169,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/snapshot/",title:"Snapshot",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#Snapshot"\u003ememorydb-controller/apis/v1alpha1#Snapshot\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshotList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshots\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a copy of an entire cluster as of the time when the snapshot was taken.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclusterName: string\nclusterRef: \n from: \n name: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nname: string\nsourceSnapshotName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe snapshot is created from this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the snapshot being created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceSnapshotName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an existing snapshot from which to make a copy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusterConfiguration: \n description: string\n engineVersion: string\n maintenanceWindow: string\n name: string\n nodeType: string\n numShards: integer\n parameterGroupName: string\n port: integer\n shards:\n configuration: \n replicaCount: integer\n slots: string\n name: string\n size: string\n snapshotCreationTime: string\n snapshotRetentionLimit: integer\n snapshotWindow: string\n subnetGroupName: string\n topicARN: string\n vpcID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsource: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration of the cluster from which the snapshot was taken\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.maintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.nodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.numShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.parameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides details of a shard in a snapshot\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].configuration.replicaCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].configuration.slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].snapshotCreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.snapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.snapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.subnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.topicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the snapshot. Valid values: creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:170,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/stage/",title:"Stage",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Stage"\u003eapigatewayv2-controller/apis/v1alpha1#Stage\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStageList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estages\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an API stage.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessLogSettings: \n destinationARN: string\n format: string\napiID: string\napiRef: \n from: \n name: string\nautoDeploy: boolean\nclientCertificateID: string\ndefaultRouteSettings: \n dataTraceEnabled: boolean\n detailedMetricsEnabled: boolean\n loggingLevel: string\n throttlingBurstLimit: integer\n throttlingRateLimit: number\ndeploymentID: string\ndeploymentRef: \n from: \n name: string\ndescription: string\nrouteSettings: {}\nstageName: string\nstageVariables: {}\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings for logging access in a stage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings.destinationARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRepresents an Amazon Resource Name (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings.format\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string with a length between [1-1024].\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoDeploy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientCertificateID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of route settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.dataTraceEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.detailedMetricsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.loggingLevel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe logging level.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.throttlingBurstLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.throttlingRateLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nlastDeploymentStatusMessage: string\nlastUpdatedDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastDeploymentStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:171,href:"https://aws-controllers-k8s.github.io/community/reference/sfn/v1alpha1/statemachine/",title:"StateMachine",description:null,content:'\u003cp\u003e\u003ccode\u003esfn.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sfn-controller/apis/v1alpha1#StateMachine"\u003esfn-controller/apis/v1alpha1#StateMachine\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStateMachine\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStateMachineList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estatemachines\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estatemachine\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edefinition: string\nloggingConfiguration: \n destinations:\n cloudWatchLogsLogGroup: \n logGroupARN: string\n includeExecutionData: boolean\n level: string\nname: string\nroleARN: string\ntags:\n- key: string\n value: string\ntracingConfiguration: \n enabled: boolean\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefinition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon States Language definition of the state machine. See Amazon States\u003cbr/\u003eLanguage (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines what execution history events are logged and where they are logged.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, the level is set to OFF. For more information see Log Levels\u003cbr/\u003e(https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html)\u003cbr/\u003ein the AWS Step Functions User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations.[].cloudWatchLogsLogGroup.logGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.includeExecutionData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.level\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the state machine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA name must not contain:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * white space\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * brackets \u0026lt; \u0026gt; { } [ ]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wildcard characters ? *\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * special characters \u0026quot; # % \\ ^\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to use for this state machine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to be added when creating a state machine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\u003cbr/\u003eTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\u003cbr/\u003ein the AWS Billing and Cost Management User Guide, and Controlling Access\u003cbr/\u003eUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\u003cbr/\u003e_ . : / = + - @.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are key-value pairs that can be associated with Step Functions state\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emachines and activities.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\nTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\nin the AWS Billing and Cost Management User Guide, and Controlling Access\nUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/p\u003e\n\u003cp\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\n_ . : / = + - @. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etracingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSelects whether AWS X-Ray tracing is enabled. |\n| \u003cstrong\u003etracingConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| **type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eDetermines whether a Standard or Express state machine is created. The default\u003cbr/\u003eis STANDARD. You cannot update the type of a state machine once it has been\u003cbr/\u003ecreated. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the state machine is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:172,href:"https://aws-controllers-k8s.github.io/community/reference/kinesis/v1alpha1/stream/",title:"Stream",description:null,content:'\u003cp\u003e\u003ccode\u003ekinesis.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kinesis-controller/apis/v1alpha1#Stream"\u003ekinesis-controller/apis/v1alpha1#Stream\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStream\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStreamList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estreams\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estream\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nshardCount: integer\nstreamModeDetails: \n streamMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name to identify the stream. The stream name is scoped to the Amazon Web\u003cbr/\u003eServices account used by the application that creates the stream. It is also\u003cbr/\u003escoped by Amazon Web Services Region. That is, two streams in two different\u003cbr/\u003eAmazon Web Services accounts can have the same name. Two streams in the same\u003cbr/\u003eAmazon Web Services account but in two different Regions can also have the\u003cbr/\u003esame name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshardCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards that the stream will use. The throughput of the stream\u003cbr/\u003eis a function of the number of shards; more shards are required for greater\u003cbr/\u003eprovisioned throughput.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamModeDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates the capacity mode of the data stream. Currently, in Kinesis Data\u003cbr/\u003eStreams, you can choose between an on-demand capacity mode and a provisioned\u003cbr/\u003ecapacity mode for your data streams.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamModeDetails.streamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconsumerCount: integer\nencryptionType: string\nenhancedMonitoring:\n shardLevelMetrics:\n - string\nkeyID: string\nopenShardCount: integer\nretentionPeriodHours: integer\nstreamCreationTimestamp: string\nstreamStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econsumerCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of enhanced fan-out consumers registered with the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe encryption type used. This value is one of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KMS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * NONE\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents the current enhanced monitoring settings of the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents enhanced metrics types.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring.[].shardLevelMetrics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenShardCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of open shards in the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionPeriodHours\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current retention period, in hours.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamCreationTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe approximate time that the stream was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the stream being described. The stream status is one\u003cbr/\u003eof the following states:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The stream is being created. Kinesis Data Streams immediately\u003cbr/\u003e returns and sets StreamStatus to CREATING.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The stream is being deleted. The specified stream is in the\u003cbr/\u003e DELETING state until Kinesis Data Streams completes the deletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The stream exists and is ready for read and write operations\u003cbr/\u003e or deletion. You should perform read and write operations only on an ACTIVE\u003cbr/\u003e stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - Shards in the stream are being merged or split. Read and\u003cbr/\u003e write operations continue to work while the stream is in the UPDATING\u003cbr/\u003e state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:173,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/subnet/",title:"Subnet",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#Subnet"\u003eec2-controller/apis/v1alpha1#Subnet\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a subnet.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassignIPv6AddressOnCreation: boolean\navailabilityZone: string\navailabilityZoneID: string\ncidrBlock: string\ncustomerOwnedIPv4Pool: string\nenableDNS64: boolean\nenableResourceNameDNSAAAARecord: boolean\nenableResourceNameDNSARecord: boolean\nhostnameType: string\nipv6CIDRBlock: string\nipv6Native: boolean\nmapPublicIPOnLaunch: boolean\noutpostARN: string\nrouteTableRefs:\n from: \n name: string\nrouteTables:\n- string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassignIPv6AddressOnCreation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Availability Zone or Local Zone for the subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Amazon Web Services selects one for you. If you create more than\u003cbr/\u003eone subnet in your VPC, we do not necessarily select a different zone for\u003cbr/\u003eeach subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a subnet in a Local Zone, set this value to the Local Zone ID,\u003cbr/\u003efor example us-west-2-lax-1a. For information about the Regions that support\u003cbr/\u003eLocal Zones, see Available Regions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a subnet in an Outpost, set this value to the Availability Zone\u003cbr/\u003efor the Outpost and specify the Outpost ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AZ ID or the Local Zone ID of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.\u003cbr/\u003eWe modify the specified CIDR block to its canonical form; for example, if\u003cbr/\u003eyou specify 100.68.0.18/18, we modify it to 100.68.0.0/18.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableDNS64\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 network range for the subnet, in CIDR notation. The subnet size\u003cbr/\u003emust use a /64 prefix length.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Native\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether to create an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emapPublicIPOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost\u003cbr/\u003eARN, you must also specify the Availability Zone of the Outpost subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailableIPAddressCount: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndefaultForAZ: boolean\nenableLniAtDeviceIndex: integer\nipv6CIDRBlockAssociationSet:\n- associationID: string\n ipv6CIDRBlock: string\n ipv6CIDRBlockState: \n state: string\n statusMessage: string\nmapCustomerOwnedIPOnLaunch: boolean\nownerID: string\nprivateDNSNameOptionsOnLaunch: \n enableResourceNameDNSAAAARecord: boolean\n enableResourceNameDNSARecord: boolean\n hostnameType: string\nstate: string\nsubnetID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailableIPAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of unused private IPv4 addresses in the subnet. The IPv4 addresses\u003cbr/\u003efor any stopped instances are considered unavailable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultForAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is the default subnet for the Availability Zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableLniAtDeviceIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eIndicates the device position for local network interfaces in this subnet.\u003cbr/\u003eFor example, 1 indicates local network interfaces in this subnet are the\u003cbr/\u003esecondary network interface (eth1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv6 CIDR blocks associated with the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a subnet and an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emapCustomerOwnedIPOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether a network interface created in this subnet (including a\u003cbr/\u003enetwork interface created by RunInstances) receives a customer-owned IPv4\u003cbr/\u003eaddress.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type of hostnames to assign to instances in the subnet at launch. An\u003cbr/\u003einstance hostname is based on the IPv4 address or ID of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.enableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.enableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.hostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:174,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/subnetgroup/",title:"SubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#SubnetGroup"\u003ememorydb-controller/apis/v1alpha1#SubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of one of the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreateSubnetGroup\u003c/li\u003e\n\u003cli\u003eUpdateSubnetGroup\nA subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of VPC subnet IDs for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnets:\n availabilityZone: \n name: string\n identifier: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of subnets associated with the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].availabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].identifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:175,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/subscription/",title:"Subscription",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#Subscription"\u003esns-controller/apis/v1alpha1#Subscription\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubscription\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubscriptionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubscriptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubscription\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA wrapper type for the attributes of an Amazon SNS subscription.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeliveryPolicy: string\nendpoint: string\nfilterPolicy: string\nfilterPolicyScope: string\nprotocol: string\nrawMessageDelivery: string\nredrivePolicy: string\nsubscriptionRoleARN: string\ntopicARN: string\ntopicRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint that you want to receive notifications. Endpoints vary by protocol:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the http protocol, the (public) endpoint is a URL beginning with\u003cbr/\u003e http://.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the https protocol, the (public) endpoint is a URL beginning with\u003cbr/\u003e https://.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the email protocol, the endpoint is an email address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the email-json protocol, the endpoint is an email address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the sms protocol, the endpoint is a phone number of an SMS-enabled\u003cbr/\u003e device.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the application protocol, the endpoint is the EndpointArn of a mobile\u003cbr/\u003e app and device.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the lambda protocol, the endpoint is the ARN of an Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis\u003cbr/\u003e Data Firehose delivery stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterPolicyScope\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprotocol\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe protocol that you want to use. Supported protocols include:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * http – delivery of JSON-encoded message via HTTP POST\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * https – delivery of JSON-encoded message via HTTPS POST\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * email – delivery of message via SMTP\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * email-json – delivery of JSON-encoded message via SMTP\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sms – delivery of message via SMS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqs – delivery of JSON-encoded message to an Amazon SQS queue\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * application – delivery of JSON-encoded message to an EndpointArn for\u003cbr/\u003e a mobile app and device\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda – delivery of JSON-encoded message to an Lambda function\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * firehose – delivery of JSON-encoded message to an Amazon Kinesis Data\u003cbr/\u003e Firehose delivery stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erawMessageDelivery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredrivePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubscriptionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the topic you want to subscribe to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfirmationWasAuthenticated: string\neffectiveDeliveryPolicy: string\nowner: string\npendingConfirmation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfirmationWasAuthenticated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeffectiveDeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingConfirmation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:176,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/table/",title:"Table",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#Table"\u003edynamodb-controller/apis/v1alpha1#Table\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eattributeDefinitions:\n- attributeName: string\n attributeType: string\nbillingMode: string\ncontinuousBackups: \n pointInTimeRecoveryEnabled: boolean\ndeletionProtectionEnabled: boolean\nglobalSecondaryIndexes:\n- indexName: string\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\n provisionedThroughput: \n readCapacityUnits: integer\n writeCapacityUnits: integer\nkeySchema:\n- attributeName: string\n keyType: string\nlocalSecondaryIndexes:\n- indexName: string\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\nprovisionedThroughput: \n readCapacityUnits: integer\n writeCapacityUnits: integer\nsseSpecification: \n enabled: boolean\n kmsMasterKeyID: string\n sseType: string\nstreamSpecification: \n streamEnabled: boolean\n streamViewType: string\ntableClass: string\ntableName: string\ntags:\n- key: string\n value: string\ntimeToLive: \n attributeName: string\n enabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of attributes that describe the key schema for the table and indexes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an attribute for describing the key schema for the table and indexes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions.[].attributeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebillingMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eControls how you are charged for read and write throughput and how you manage\u003cbr/\u003ecapacity. This setting can be changed later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PROVISIONED - We recommend using PROVISIONED for predictable workloads.\u003cbr/\u003e PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable\u003cbr/\u003e workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtinuousBackups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable point in time recovery.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtinuousBackups.pointInTimeRecoveryEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtectionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether deletion protection is to be enabled (true) or disabled\u003cbr/\u003e(false) on the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more global secondary indexes (the maximum is 20) to be created on\u003cbr/\u003ethe table. Each global secondary index in the array includes the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IndexName - The name of the global secondary index. Must be unique only\u003cbr/\u003e for this table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeySchema - Specifies the key schema for the global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Projection - Specifies attributes that are copied (projected) from the\u003cbr/\u003e table into the index. These are in addition to the primary key attributes\u003cbr/\u003e and index key attributes, which are automatically projected. Each attribute\u003cbr/\u003e specification is composed of: ProjectionType - One of the following: KEYS_ONLY\u003cbr/\u003e - Only the index and primary keys are projected into the index. INCLUDE\u003cbr/\u003e - Only the specified table attributes are projected into the index. The\u003cbr/\u003e list of projected attributes is in NonKeyAttributes. ALL - All of the\u003cbr/\u003e table attributes are projected into the index. NonKeyAttributes - A list\u003cbr/\u003e of one or more non-key attribute names that are projected into the secondary\u003cbr/\u003e index. The total count of attributes provided in NonKeyAttributes, summed\u003cbr/\u003e across all of the secondary indexes, must not exceed 100. If you project\u003cbr/\u003e the same attribute into two different indexes, this counts as two distinct\u003cbr/\u003e attributes when determining the total.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ProvisionedThroughput - The provisioned throughput settings for the\u003cbr/\u003e global secondary index, consisting of read and write capacity units.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a global secondary index.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat make up the primary key of a table, or the key attributes of an index.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eglobalSecondaryIndexes.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for a specified table or index.\u003cbr/\u003eThe settings can be modified using the UpdateTable operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor current minimum and maximum provisioned throughput values, see Service,\u003cbr/\u003eAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ekeySchema\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the attributes that make up the primary key for a table or an index.\u003cbr/\u003eThe attributes in KeySchema must also be defined in the AttributeDefinitions\u003cbr/\u003earray. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach KeySchemaElement in the array is composed of:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AttributeName - The name of this key attribute.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeyType - The role that the key attribute will assume: HASH - partition\u003cbr/\u003e key RANGE - sort key\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe partition key of an item is also known as its hash attribute. The term\u003cbr/\u003e\u0026ldquo;hash attribute\u0026rdquo; derives from the DynamoDB usage of an internal hash function\u003cbr/\u003eto evenly distribute data items across partitions, based on their partition\u003cbr/\u003ekey values.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe sort key of an item is also known as its range attribute. The term \u0026ldquo;range\u003cbr/\u003eattribute\u0026rdquo; derives from the way DynamoDB stores items with the same partition\u003cbr/\u003ekey physically close together, in sorted order by the sort key value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a simple primary key (partition key), you must provide exactly one element\u003cbr/\u003ewith a KeyType of HASH.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a composite primary key (partition key and sort key), you must provide\u003cbr/\u003eexactly two elements, in this order: The first element must have a KeyType\u003cbr/\u003eof HASH, and the second element must have a KeyType of RANGE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003ekeySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003ekeySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ekeySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more local secondary indexes (the maximum is 5) to be created on the\u003cbr/\u003etable. Each index is scoped to a given partition key value. There is a 10\u003cbr/\u003eGB size limit per partition key value; otherwise, the size of a local secondary\u003cbr/\u003eindex is unconstrained.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach local secondary index in the array includes the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IndexName - The name of the local secondary index. Must be unique only\u003cbr/\u003e for this table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeySchema - Specifies the key schema for the local secondary index.\u003cbr/\u003e The key schema must begin with the same partition key as the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Projection - Specifies attributes that are copied (projected) from the\u003cbr/\u003e table into the index. These are in addition to the primary key attributes\u003cbr/\u003e and index key attributes, which are automatically projected. Each attribute\u003cbr/\u003e specification is composed of: ProjectionType - One of the following: KEYS_ONLY\u003cbr/\u003e - Only the index and primary keys are projected into the index. INCLUDE\u003cbr/\u003e - Only the specified table attributes are projected into the index. The\u003cbr/\u003e list of projected attributes is in NonKeyAttributes. ALL - All of the\u003cbr/\u003e table attributes are projected into the index. NonKeyAttributes - A list\u003cbr/\u003e of one or more non-key attribute names that are projected into the secondary\u003cbr/\u003e index. The total count of attributes provided in NonKeyAttributes, summed\u003cbr/\u003e across all of the secondary indexes, must not exceed 100. If you project\u003cbr/\u003e the same attribute into two different indexes, this counts as two distinct\u003cbr/\u003e attributes when determining the total. |\n| \u003cstrong\u003elocalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a local secondary index. || \u003cstrong\u003elocalSecondaryIndexes.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003elocalSecondaryIndexes.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprovisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for a specified table or index.\u003cbr/\u003eThe settings can be modified using the UpdateTable operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you set BillingMode as PROVISIONED, you must specify this property. If\u003cbr/\u003eyou set BillingMode as PAY_PER_REQUEST, you cannot specify this property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor current minimum and maximum provisioned throughput values, see Service,\u003cbr/\u003eAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003eprovisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprovisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable server-side encryption. |\n| \u003cstrong\u003esseSpecification.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification.kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification.sseType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estreamSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for DynamoDB Streams on the table. These settings consist of:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled\u003cbr/\u003e (true) or disabled (false).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamViewType - When an item in the table is modified, StreamViewType\u003cbr/\u003e determines what information is written to the table\u0026rsquo;s stream. Valid values\u003cbr/\u003e for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified\u003cbr/\u003e item are written to the stream. NEW_IMAGE - The entire item, as it appears\u003cbr/\u003e after it was modified, is written to the stream. OLD_IMAGE - The entire\u003cbr/\u003e item, as it appeared before it was modified, is written to the stream.\u003cbr/\u003e NEW_AND_OLD_IMAGES - Both the new and the old item images of the item\u003cbr/\u003e are written to the stream. |\n| \u003cstrong\u003estreamSpecification.streamEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estreamSpecification.streamViewType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etableClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS. |\n| \u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table to create. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pairs to label the table. For more information, see Tagging\u003cbr/\u003efor DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html). |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\na single DynamoDB table.\u003c/p\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)\nin the Amazon DynamoDB Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etimeToLive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable or disable Time to Live for the specified\u003cbr/\u003etable. |\n| \u003cstrong\u003etimeToLive.attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etimeToLive.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\narchivalSummary: \n archivalBackupARN: string\n archivalDateTime: string\n archivalReason: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDateTime: string\nglobalSecondaryIndexesDescriptions:\n- backfilling: boolean\n indexARN: string\n indexName: string\n indexSizeBytes: integer\n indexStatus: string\n itemCount: integer\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\n provisionedThroughput: \n lastDecreaseDateTime: string\n lastIncreaseDateTime: string\n numberOfDecreasesToday: integer\n readCapacityUnits: integer\n writeCapacityUnits: integer\nglobalTableVersion: string\nitemCount: integer\nlatestStreamARN: string\nlatestStreamLabel: string\nreplicas:\n globalSecondaryIndexes:\n - indexName: string\n provisionedThroughputOverride: \n readCapacityUnits: integer\n kmsMasterKeyID: string\n provisionedThroughputOverride: \n readCapacityUnits: integer\n regionName: string\n replicaInaccessibleDateTime: string\n replicaStatus: string\n replicaStatusDescription: string\n replicaStatusPercentProgress: string\n replicaTableClassSummary: \n lastUpdateDateTime: string\n tableClass: string\nrestoreSummary: \n restoreDateTime: string\n restoreInProgress: boolean\n sourceBackupARN: string\n sourceTableARN: string\ntableID: string\ntableSizeBytes: integer\ntableStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the table archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalBackupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)\u003cbr/\u003eformat.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a global secondary index.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].itemCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat make up the primary key of a table, or the key attributes of an index.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for the table, consisting\u003cbr/\u003eof read and write capacity units, along with data about increases and decreases. |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.lastDecreaseDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.lastIncreaseDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.numberOfDecreasesToday\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalTableVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRepresents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)\u003cbr/\u003ein use, if the table is replicated across Amazon Web Services Regions. |\n| \u003cstrong\u003eitemCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of items in the specified table. DynamoDB updates this value approximately\u003cbr/\u003eevery six hours. Recent changes might not be reflected in this value. |\n| \u003cstrong\u003elatestStreamARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that uniquely identifies the latest stream\u003cbr/\u003efor this table. |\n| \u003cstrong\u003elatestStreamLabel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp, in ISO 8601 format, for this stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote that LatestStreamLabel is not a unique identifier for the stream, because\u003cbr/\u003eit is possible that a stream from another table might have the same timestamp.\u003cbr/\u003eHowever, the combination of the following three elements is guaranteed to\u003cbr/\u003ebe unique:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Web Services customer ID\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Table name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamLabel |\n| \u003cstrong\u003ereplicas\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents replicas of the table. |\n| \u003cstrong\u003ereplicas.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the details of the replica. || \u003cstrong\u003ereplicas.[].globalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a replica global secondary index. || \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].provisionedThroughputOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReplica-specific provisioned throughput settings. If not specified, uses\u003cbr/\u003ethe source table\u0026rsquo;s provisioned throughput settings. |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].provisionedThroughputOverride.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].provisionedThroughputOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReplica-specific provisioned throughput settings. If not specified, uses\u003cbr/\u003ethe source table\u0026rsquo;s provisioned throughput settings. |\n| \u003cstrong\u003ereplicas.[].provisionedThroughputOverride.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].regionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaInaccessibleDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatusDescription\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatusPercentProgress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details of the table class. |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary.lastUpdateDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary.tableClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details for the restore. |\n| \u003cstrong\u003erestoreSummary.restoreDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.restoreInProgress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.sourceBackupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.sourceTableARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etableID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique identifier for the table for which the backup was created. |\n| \u003cstrong\u003etableSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe total size of the specified table, in bytes. DynamoDB updates this value\u003cbr/\u003eapproximately every six hours. Recent changes might not be reflected in this\u003cbr/\u003evalue. |\n| \u003cstrong\u003etableStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the table:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The table is being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - The table/index configuration is being updated. The table/index\u003cbr/\u003e remains available for data operations when UPDATING.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The table is being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The table is ready for use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the\u003cbr/\u003e table in inaccessible. Table operations may fail due to failure to use\u003cbr/\u003e the KMS key. DynamoDB will initiate the table archival process when a\u003cbr/\u003e table\u0026rsquo;s KMS key remains inaccessible for more than seven days.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARCHIVING - The table is being archived. Operations are not allowed\u003cbr/\u003e until archival is complete.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARCHIVED - The table has been archived. See the ArchivalReason for more\u003cbr/\u003e information. |\u003c/p\u003e\n'}).add({id:177,href:"https://aws-controllers-k8s.github.io/community/reference/keyspaces/v1alpha1/table/",title:"Table",description:null,content:'\u003cp\u003e\u003ccode\u003ekeyspaces.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/keyspaces-controller/apis/v1alpha1#Table"\u003ekeyspaces-controller/apis/v1alpha1#Table\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacitySpecification: \n readCapacityUnits: integer\n throughputMode: string\n writeCapacityUnits: integer\nclientSideTimestamps: \n status: string\ncomment: \n message: string\ndefaultTimeToLive: integer\nencryptionSpecification: \n kmsKeyIdentifier: string\n type_: string\nkeyspaceName: string\npointInTimeRecovery: \n status: string\nschemaDefinition: \n allColumns:\n - name: string\n type_: string\n clusteringKeys:\n - name: string\n orderBy: string\n partitionKeys:\n - name: string\n staticColumns:\n - name: string\ntableName: string\ntags:\n- key: string\n value: string\nttl: \n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the read/write throughput capacity mode for the table. The options\u003cbr/\u003eare:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * throughputMode:PAY_PER_REQUEST and\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits\u003cbr/\u003e and writeCapacityUnits as input.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is throughput_mode:PAY_PER_REQUEST.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.throughputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientSideTimestamps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnables client-side timestamps for the table. By default, the setting is\u003cbr/\u003edisabled. You can enable client-side timestamps with the following option:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status: \u0026ldquo;enabled\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnce client-side timestamps are enabled for a table, this setting cannot\u003cbr/\u003ebe disabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientSideTimestamps.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter allows to enter a description of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomment.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultTimeToLive\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe default Time to Live setting in seconds for the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies how the encryption key for encryption at rest is managed for the\u003cbr/\u003etable. You can choose one of the following KMS key (KMS key):\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and\u003cbr/\u003e is created, owned, and managed by you. This option requires the kms_key_identifier\u003cbr/\u003e of the KMS key in Amazon Resource Name (ARN) format as input.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is type:AWS_OWNED_KMS_KEY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionSpecification.kmsKeyIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionSpecification.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyspaceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the keyspace that the table is going to be created in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epointInTimeRecovery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies if pointInTimeRecovery is enabled or disabled for the table. The\u003cbr/\u003eoptions are:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status=ENABLED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status=DISABLED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf it\u0026rsquo;s not specified, the default is status=DISABLED.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epointInTimeRecovery.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe schemaDefinition consists of the following parameters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor each column to be created:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type - An Amazon Keyspaces data type. For more information, see Data\u003cbr/\u003e types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types)\u003cbr/\u003e in the Amazon Keyspaces Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe primary key of the table consists of the following columns:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * partitionKeys - The partition key can be a single column, or it can\u003cbr/\u003e be a compound value composed of two or more columns. The partition key\u003cbr/\u003e portion of the primary key is required and determines how Amazon Keyspaces\u003cbr/\u003e stores your data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of each partition key column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * clusteringKeys - The optional clustering column portion of your primary\u003cbr/\u003e key determines how the data is clustered and sorted within each partition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the clustering column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.\u003cbr/\u003e To define a column as static use staticColumns - Static columns store\u003cbr/\u003e values that are shared by all rows in the same partition:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type - An Amazon Keyspaces data type.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.allColumns\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.allColumns.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe names and data types of regular columns.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**schemaDefinition.allColumns.[].type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe optional clustering column portion of your primary key determines how\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe data is clustered and sorted within each partition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys.[].orderBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.partitionKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.partitionKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe partition key portion of the primary key is required and determines how\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAmazon Keyspaces stores the data. The partition key can be a single column,\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor it can be a compound value composed of two or more columns.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.staticColumns\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.staticColumns.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe static columns of the table. Static columns store values that are shared\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eby all rows in the same partition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pair tags to be attached to the resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\u003cbr/\u003e(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea single Amazon Keyspaces resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\n(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\nin the Amazon Keyspaces Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ettl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnables Time to Live custom settings for the table. The options are:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status:enabled\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status:disabled\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is status:disabled. After ttl is enabled, you can\u0026rsquo;t disable it\u003cbr/\u003efor the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Expiring data by using Amazon Keyspaces Time to\u003cbr/\u003eLive (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide. |\n| \u003cstrong\u003ettl.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:178,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/taskdefinition/",title:"TaskDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#TaskDefinition"\u003eecs-controller/apis/v1alpha1#TaskDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTaskDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTaskDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etaskdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etaskdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details of a task definition which describes the container and volume\ndefinitions of an Amazon Elastic Container Service task. You can specify\nwhich Docker images to use, the required resources, and other configurations\nrelated to launching the task definition through an Amazon ECS service or\ntask.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainerDefinitions:\n command:\n - string\n cpu: integer\n credentialSpecs:\n - string\n dependsOn:\n - condition: string\n containerName: string\n disableNetworking: boolean\n dnsSearchDomains:\n - string\n dnsServers:\n - string\n dockerLabels: {}\n dockerSecurityOptions:\n - string\n entryPoint:\n - string\n environment:\n - name: string\n value: string\n environmentFiles:\n - type: string\n value: string\n essential: boolean\n extraHosts:\n - hostname: string\n ipAddress: string\n firelensConfiguration: \n options: {}\n type: string\n healthCheck: \n command:\n - string\n interval: integer\n retries: integer\n startPeriod: integer\n timeout: integer\n hostname: string\n image: string\n interactive: boolean\n links:\n - string\n linuxParameters: \n capabilities: \n add:\n - string\n drop:\n - string\n devices:\n - containerPath: string\n hostPath: string\n permissions:\n - string\n initProcessEnabled: boolean\n maxSwap: integer\n sharedMemorySize: integer\n swappiness: integer\n tmpfs:\n - containerPath: string\n mountOptions:\n - string\n size: integer\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n memory: integer\n memoryReservation: integer\n mountPoints:\n - containerPath: string\n readOnly: boolean\n sourceVolume: string\n name: string\n portMappings:\n - appProtocol: string\n containerPort: integer\n containerPortRange: string\n hostPort: integer\n name: string\n protocol: string\n privileged: boolean\n pseudoTerminal: boolean\n readonlyRootFilesystem: boolean\n repositoryCredentials: \n credentialsParameter: string\n resourceRequirements:\n - type: string\n value: string\n secrets:\n - name: string\n valueFrom: string\n startTimeout: integer\n stopTimeout: integer\n systemControls:\n - namespace: string\n value: string\n ulimits:\n - hardLimit: integer\n name: string\n softLimit: integer\n user: string\n volumesFrom:\n - readOnly: boolean\n sourceContainer: string\n workingDirectory: string\ncpu: string\nephemeralStorage: \n sizeInGiB: integer\nexecutionRoleARN: string\nfamily: string\ninferenceAccelerators:\n- deviceName: string\n deviceType: string\nipcMode: string\nmemory: string\nnetworkMode: string\npidMode: string\nplacementConstraints:\n- expression: string\n type: string\nproxyConfiguration: \n containerName: string\n properties:\n - name: string\n value: string\n type: string\nrequiresCompatibilities:\n- string\nruntimePlatform: \n cpuArchitecture: string\n operatingSystemFamily: string\ntags:\n- key: string\n value: string\ntaskRoleARN: string\ntaskRoleRef: \n from: \n name: string\nvolumes:\n- configuredAtLaunch: boolean\n dockerVolumeConfiguration: \n autoprovision: boolean\n driver: string\n driverOpts: {}\n labels: {}\n scope: string\n efsVolumeConfiguration: \n authorizationConfig: \n accessPointID: string\n iam: string\n fileSystemID: string\n rootDirectory: string\n transitEncryption: string\n transitEncryptionPort: integer\n fsxWindowsFileServerVolumeConfiguration: \n authorizationConfig: \n credentialsParameter: string\n domain: string\n fileSystemID: string\n rootDirectory: string\n host: \n sourcePath: string\n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of container definitions in JSON format that describe the different\u003cbr/\u003econtainers that make up your task.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer definitions are used in task definitions to describe the different\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtainers that are launched as part of a task.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].credentialSpecs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].credentialSpecs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].dependsOn.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe dependencies defined for container startup and shutdown. A container\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan contain multiple dependencies. When a dependency is defined for container\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003estartup, for container shutdown it is reversed.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYour Amazon ECS container instances require at least version 1.26.0 of the\ncontainer agent to use container dependencies. However, we recommend using\nthe latest container agent version. For information about checking your agent\nversion and updating to the latest version, see Updating the Amazon ECS Container\nAgent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)\nin the Amazon Elastic Container Service Developer Guide. If you\u0026rsquo;re using\nan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1\nof the ecs-init package. If your container instances are launched from version\n20190301 or later, then they contain the required versions of the container\nagent and ecs-init. For more information, see Amazon ECS-optimized Linux\nAMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eFor tasks that use the Fargate launch type, the task or service requires\nthe following platforms:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.3.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information about how to create a container dependency, see Container\ndependency (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].dependsOn.[].condition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dependsOn.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].disableNetworking\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsSearchDomains\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsSearchDomains.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].dnsServers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsServers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].dockerLabels\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dockerSecurityOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dockerSecurityOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].entryPoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environment.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object. || \u003cstrong\u003econtainerDefinitions.[].environment.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environment.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of files containing the environment variables to pass to a container.\nYou can specify up to ten environment files. The file must have a .env file\nextension. Each line in an environment file should contain an environment\nvariable in VARIABLE=VALUE format. Lines beginning with # are treated as\ncomments and are ignored.\u003c/p\u003e\n\u003cp\u003eIf there are environment variables specified using the environment parameter\nin a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that\ncontain the same variable, they\u0026rsquo;re processed from the top down. We recommend\nthat you use unique variable names. For more information, see Specifying\nenvironment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eYou must use the following platforms for the Fargate launch type:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.4.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eConsider the following when using the Fargate launch type:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe file is handled like a native Docker env-file.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThere is no support for shell escape handling.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe container entry point interperts the VARIABLE values. || \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].essential\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eHostnames and IP address entries that are added to the /etc/hosts file of\na container via the extraHosts parameter of its ContainerDefinition. || \u003cstrong\u003econtainerDefinitions.[].extraHosts.[].hostname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts.[].ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe FireLens configuration for the container. This is used to specify and\u003cbr/\u003econfigure a log router for container logs. For more information, see Custom\u003cbr/\u003elog routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container health check. Health check parameters\u003cbr/\u003ethat are specified in a container definition override any Docker health checks\u003cbr/\u003ethat exist in the container image (such as those specified in a parent image\u003cbr/\u003eor from the image\u0026rsquo;s Dockerfile). This configuration maps to the HEALTHCHECK\u003cbr/\u003eparameter of docker run (https://docs.docker.com/engine/reference/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon ECS container agent only monitors and reports on the health checks\u003cbr/\u003especified in the task definition. Amazon ECS does not monitor Docker health\u003cbr/\u003echecks that are embedded in a container image and not specified in the container\u003cbr/\u003edefinition. Health check parameters that are specified in a container definition\u003cbr/\u003eoverride any Docker health checks that exist in the container image.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can view the health status of both individual containers and a task with\u003cbr/\u003ethe DescribeTasks API operation or when viewing the task details in the console.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe health check is designed to make sure that your containers survive agent\u003cbr/\u003erestarts, upgrades, or temporary unavailability.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following describes the possible healthStatus values for a container:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HEALTHY-The container health check has passed successfully.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNHEALTHY-The container health check has failed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNKNOWN-The container health check is being evaluated, there\u0026rsquo;s no container\u003cbr/\u003e health check defined, or Amazon ECS doesn\u0026rsquo;t have the health status of\u003cbr/\u003e the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following describes the possible healthStatus values based on the container\u003cbr/\u003ehealth checker status of essential containers in the task with the following\u003cbr/\u003epriority order (high to low):\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNHEALTHY-One or more essential containers have failed their health\u003cbr/\u003e check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNKNOWN-Any essential container running within the task is in an UNKNOWN\u003cbr/\u003e state and no other essential containers have an UNHEALTHY state.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HEALTHY-All essential containers within the task have passed their health\u003cbr/\u003e checks.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConsider the following task health example with 2 containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health\u003cbr/\u003e is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health\u003cbr/\u003e is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, the task health\u003cbr/\u003e is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is HEALTHY, the task health\u003cbr/\u003e is HEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConsider the following task health example with 3 containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3\u003cbr/\u003e is UNKNOWN, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3\u003cbr/\u003e is HEALTHY, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3\u003cbr/\u003e is HEALTHY, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is\u003cbr/\u003e HEALTHY, the task health is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is\u003cbr/\u003e UNKNOWN, the task health is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is\u003cbr/\u003e HEALTHY, the task health is HEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a task is run manually, and not as part of a service, the task will continue\u003cbr/\u003eits lifecycle regardless of its health status. For tasks that are part of\u003cbr/\u003ea service, if the task reports as unhealthy then the task will be stopped\u003cbr/\u003eand the service scheduler will replace it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are notes about container health check support:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the Amazon ECS agent cannot connect to the Amazon ECS service,\u003cbr/\u003e the service reports the container as UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The health check statuses are the \u0026ldquo;last heard from\u0026rdquo; response from the\u003cbr/\u003e Amazon ECS agent. There are no assumptions made about the status of the\u003cbr/\u003e container health checks.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks require version 1.17.0 or greater of the Amazon\u003cbr/\u003e ECS container agent. For more information, see Updating the Amazon ECS\u003cbr/\u003e container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks are supported for Fargate tasks if you\u0026rsquo;re using\u003cbr/\u003e platform version 1.1.0 or greater. For more information, see Fargate platform\u003cbr/\u003e versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks aren\u0026rsquo;t supported for tasks that are part of\u003cbr/\u003e a service that\u0026rsquo;s configured to use a Classic Load Balancer. |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.command\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].healthCheck.interval\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.retries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.startPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].hostname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].image\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].interactive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].links\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].links.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Linux-specific options that are applied to the container, such as Linux\u003cbr/\u003eKernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Linux capabilities for the container that are added to or dropped from\u003cbr/\u003ethe default configuration provided by Docker. For more information about\u003cbr/\u003ethe default capabilities and the non-default available capabilities, see\u003cbr/\u003eRuntime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities)\u003cbr/\u003ein the Docker run reference. For more detailed information about these Linux\u003cbr/\u003ecapabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html)\u003cbr/\u003eLinux manual page. |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.add\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.add.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.drop\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.drop.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container instance host device. || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].hostPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].permissions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].permissions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.initProcessEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.maxSwap\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.sharedMemorySize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.swappiness\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container path, mount options, and size of the tmpfs mount. || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].mountOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].mountOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].size\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].memory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].memoryReservation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for a volume mount point that\u0026rsquo;s used in a container definition. || \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].readOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].sourceVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003ePort mappings allow containers to access ports on the host container instance\nto send or receive traffic. Port mappings are specified as part of the container\ndefinition.\u003c/p\u003e\n\u003cp\u003eIf you use containers in a task with the awsvpc or host network mode, specify\nthe exposed ports using containerPort. The hostPort can be left blank or\nit must be the same value as the containerPort.\u003c/p\u003e\n\u003cp\u003eMost fields of this parameter (containerPort, hostPort, protocol) maps to\nPortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\nsection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\nand the \u0026ndash;publish option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\nIf the network mode of a task definition is set to host, host ports must\neither be undefined or match the container port in the port mapping.\u003c/p\u003e\n\u003cp\u003eYou can\u0026rsquo;t expose the same container port for multiple protocols. If you attempt\nthis, an error is returned.\u003c/p\u003e\n\u003cp\u003eAfter a task reaches the RUNNING status, manual and automatic host and container\nport assignments are visible in the networkBindings section of DescribeTasks\nAPI responses. || \u003cstrong\u003econtainerDefinitions.[].portMappings.[].appProtocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].containerPortRange\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].hostPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].protocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].privileged\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].pseudoTerminal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].readonlyRootFilesystem\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].repositoryCredentials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe repository credentials for private registry authentication. |\n| \u003cstrong\u003econtainerDefinitions.[].repositoryCredentials.credentialsParameter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresource types are GPUs and Elastic Inference accelerators. For more information,\nsee Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html)\nor Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide || \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].secrets.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].startTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].stopTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of namespaced kernel parameters to set in the container. This parameter\nmaps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\nsection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\nand the \u0026ndash;sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).\nFor example, you can configure net.ipv4.tcp_keepalive_time setting to maintain\nlonger lived connections.\u003c/p\u003e\n\u003cp\u003eWe don\u0026rsquo;t recommend that you specify network-related systemControls parameters\nfor multiple containers in a single task that also uses either the awsvpc\nor host network mode. Doing this has the following disadvantages:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the awsvpc network mode including Fargate, if you\nset systemControls for any container, it applies to all containers in\nthe task. If you set different systemControls for multiple containers\nin a single task, the container that\u0026rsquo;s started last determines which systemControls\ntake effect.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the host network mode, the network namespace systemControls\naren\u0026rsquo;t supported.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you\u0026rsquo;re setting an IPC resource namespace to use for the containers in\nthe task, the following conditions apply to your system controls. For more\ninformation, see IPC mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the host IPC mode, IPC namespace systemControls aren\u0026rsquo;t\nsupported.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the task IPC mode, IPC namespace systemControls values\napply to all containers within a task.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThis parameter is not supported for Windows containers.\u003c/p\u003e\n\u003cp\u003eThis parameter is only supported for tasks that are hosted on Fargate if\nthe tasks are using platform version 1.4.0 or later (Linux). This isn\u0026rsquo;t supported\nfor Windows containers on Fargate. || \u003cstrong\u003econtainerDefinitions.[].systemControls.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ulimit settings to pass to the container.\u003c/p\u003e\n\u003cp\u003eAmazon ECS tasks hosted on Fargate use the default resource limit values\nset by the operating system with the exception of the nofile resource limit\nparameter which Fargate overrides. The nofile resource limit sets a restriction\non the number of open files that a container can use. The default nofile\nsoft limit is 1024 and the default hard limit is 65535.\u003c/p\u003e\n\u003cp\u003eYou can specify the ulimit settings for a container in a task definition. || \u003cstrong\u003econtainerDefinitions.[].ulimits.[].hardLimit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[].softLimit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].user\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on a data volume from another container in the same task definition. || \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[].readOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[].sourceContainer\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].workingDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecpu\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe number of CPU units used by the task. It can be expressed as an integer\u003cbr/\u003eusing CPU units (for example, 1024) or as a string using vCPUs (for example,\u003cbr/\u003e1 vCPU or 1 vcpu) in a task definition. String values are converted to an\u003cbr/\u003einteger indicating the CPU units when the task definition is registered.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTask-level CPU and memory parameters are ignored for Windows containers.\u003cbr/\u003eWe recommend specifying container-level resources for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re using the EC2 launch type, this field is optional. Supported values\u003cbr/\u003eare between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If\u003cbr/\u003eyou do not specify a value, the parameter is ignored.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re using the Fargate launch type, this field is required and you must\u003cbr/\u003euse one of the following values, which determines your range of supported\u003cbr/\u003evalues for the memory parameter:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe CPU units cannot be less than 1 vCPU when you use Windows containers\u003cbr/\u003eon Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB),\u003cbr/\u003e 2048 (2 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072\u003cbr/\u003e (3 GB), 4096 (4 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096\u003cbr/\u003e (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB)\u003cbr/\u003e in increments of 1024 (1 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB)\u003cbr/\u003e in increments of 1024 (1 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments\u003cbr/\u003e This option requires Linux platform 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments\u003cbr/\u003e This option requires Linux platform 1.4.0 or later. |\n| \u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe amount of ephemeral storage to allocate for the task. This parameter\u003cbr/\u003eis used to expand the total amount of ephemeral storage available, beyond\u003cbr/\u003ethe default amount, for tasks hosted on Fargate. For more information, see\u003cbr/\u003eUsing data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)\u003cbr/\u003ein the Amazon ECS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tasks using the Fargate launch type, the task requires the following\u003cbr/\u003eplatforms:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Linux platform version 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Windows platform version 1.0.0 or later. |\n| \u003cstrong\u003eephemeralStorage.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the task execution role that grants the\u003cbr/\u003eAmazon ECS container agent permission to make Amazon Web Services API calls\u003cbr/\u003eon your behalf. The task execution IAM role is required depending on the\u003cbr/\u003erequirements of your task. For more information, see Amazon ECS task execution\u003cbr/\u003eIAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eYou must specify a family for a task definition. You can use it track multiple\u003cbr/\u003eversions of the same task definition. The family is used as a name for your\u003cbr/\u003etask definition. Up to 255 letters (uppercase and lowercase), numbers, underscores,\u003cbr/\u003eand hyphens are allowed. |\n| \u003cstrong\u003einferenceAccelerators\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Elastic Inference accelerators to use for the containers in the task. |\n| \u003cstrong\u003einferenceAccelerators.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on an Elastic Inference accelerator. For more information, see Working\nwith Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003einferenceAccelerators.[].deviceName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einferenceAccelerators.[].deviceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eipcMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPC resource namespace to use for the containers in the task. The valid\u003cbr/\u003evalues are host, task, or none. If host is specified, then all containers\u003cbr/\u003ewithin the tasks that specified the host IPC mode on the same container instance\u003cbr/\u003eshare the same IPC resources with the host Amazon EC2 instance. If task is\u003cbr/\u003especified, all containers within the specified task share the same IPC resources.\u003cbr/\u003eIf none is specified, then IPC resources within the containers of a task\u003cbr/\u003eare private and not shared with other containers in a task or on the container\u003cbr/\u003einstance. If no value is specified, then the IPC resource namespace sharing\u003cbr/\u003edepends on the Docker daemon setting on the container instance. For more\u003cbr/\u003einformation, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings\u0026mdash;ipc)\u003cbr/\u003ein the Docker run reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the host IPC mode is used, be aware that there is a heightened risk of\u003cbr/\u003eundesired IPC namespace expose. For more information, see Docker security\u003cbr/\u003e(https://docs.docker.com/engine/security/security/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are setting namespaced kernel parameters using systemControls for\u003cbr/\u003ethe containers in the task, the following will apply to your IPC resource\u003cbr/\u003enamespace. For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that use the host IPC mode, IPC namespace related systemControls\u003cbr/\u003e are not supported.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that use the task IPC mode, IPC namespace related systemControls\u003cbr/\u003e will apply to all containers within a task.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for Windows containers or tasks run on Fargate. |\n| \u003cstrong\u003ememory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe amount of memory (in MiB) used by the task. It can be expressed as an\u003cbr/\u003einteger using MiB (for example ,1024) or as a string using GB (for example,\u003cbr/\u003e1GB or 1 GB) in a task definition. String values are converted to an integer\u003cbr/\u003eindicating the MiB when the task definition is registered.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTask-level CPU and memory parameters are ignored for Windows containers.\u003cbr/\u003eWe recommend specifying container-level resources for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf using the EC2 launch type, this field is optional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf using the Fargate launch type, this field is required and you must use\u003cbr/\u003eone of the following values. This determines your range of supported values\u003cbr/\u003efor the cpu parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe CPU units cannot be less than 1 vCPU when you use Windows containers\u003cbr/\u003eon Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25\u003cbr/\u003e vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:\u003cbr/\u003e 512 (.5 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168\u003cbr/\u003e (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -\u003cbr/\u003e Available cpu values: 2048 (2 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -\u003cbr/\u003e Available cpu values: 4096 (4 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192\u003cbr/\u003e (8 vCPU) This option requires Linux platform 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384\u003cbr/\u003e (16 vCPU) This option requires Linux platform 1.4.0 or later. |\n| \u003cstrong\u003enetworkMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Docker networking mode to use for the containers in the task. The valid\u003cbr/\u003evalues are none, bridge, awsvpc, and host. If no network mode is specified,\u003cbr/\u003ethe default is bridge.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Amazon ECS tasks on Fargate, the awsvpc network mode is required. For\u003cbr/\u003eAmazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used.\u003cbr/\u003eFor Amazon ECS tasks on Amazon EC2 Windows instances, \u003cdefault\u003e or awsvpc\u003cbr/\u003ecan be used. If the network mode is set to none, you cannot specify port\u003cbr/\u003emappings in your container definitions, and the tasks containers do not have\u003cbr/\u003eexternal connectivity. The host and awsvpc network modes offer the highest\u003cbr/\u003enetworking performance for containers because they use the EC2 network stack\u003cbr/\u003einstead of the virtualized network stack provided by the bridge mode.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWith the host and awsvpc network modes, exposed container ports are mapped\u003cbr/\u003edirectly to the corresponding host port (for the host network mode) or the\u003cbr/\u003eattached elastic network interface port (for the awsvpc network mode), so\u003cbr/\u003eyou cannot take advantage of dynamic host port mappings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen using the host network mode, you should not run containers using the\u003cbr/\u003eroot user (UID 0). It is considered best practice to use a non-root user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the network mode is awsvpc, the task is allocated an elastic network interface,\u003cbr/\u003eand you must specify a NetworkConfiguration value when you create a service\u003cbr/\u003eor run a task with the task definition. For more information, see Task Networking\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the network mode is host, you cannot run multiple instantiations of the\u003cbr/\u003esame task on a single container instance when port mappings are used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings)\u003cbr/\u003ein the Docker run reference. |\n| \u003cstrong\u003epidMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe process namespace to use for the containers in the task. The valid values\u003cbr/\u003eare host or task. On Fargate for Linux containers, the only valid value is\u003cbr/\u003etask. For example, monitoring sidecars might need pidMode to access information\u003cbr/\u003eabout other containers running in the same task.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf host is specified, all containers within the tasks that specified the\u003cbr/\u003ehost PID mode on the same container instance share the same process namespace\u003cbr/\u003ewith the host Amazon EC2 instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf task is specified, all containers within the specified task share the\u003cbr/\u003esame process namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf no value is specified, the default is a private namespace for each container.\u003cbr/\u003eFor more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings\u0026mdash;pid)\u003cbr/\u003ein the Docker run reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the host PID mode is used, there\u0026rsquo;s a heightened risk of undesired process\u003cbr/\u003enamespace exposure. For more information, see Docker security (https://docs.docker.com/engine/security/security/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for tasks that are hosted on Fargate if\u003cbr/\u003ethe tasks are using platform version 1.4.0 or later (Linux). This isn\u0026rsquo;t supported\u003cbr/\u003efor Windows containers on Fargate. |\n| \u003cstrong\u003eplacementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of placement constraint objects to use for the task. You can specify\u003cbr/\u003ea maximum of 10 constraints for each task. This limit includes constraints\u003cbr/\u003ein the task definition and those specified at runtime. |\n| \u003cstrong\u003eplacementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraint on task placement in the task definition. For more information,\nsee Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eTask placement constraints aren\u0026rsquo;t supported for tasks run on Fargate. || \u003cstrong\u003eplacementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementConstraints.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details for the App Mesh proxy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tasks hosted on Amazon EC2 instances, the container instances require\u003cbr/\u003eat least version 1.26.0 of the container agent and at least version 1.26.0-1\u003cbr/\u003eof the ecs-init package to use a proxy configuration. If your container instances\u003cbr/\u003eare launched from the Amazon ECS-optimized AMI version 20190301 or later,\u003cbr/\u003ethen they contain the required versions of the container agent and ecs-init.\u003cbr/\u003eFor more information, see Amazon ECS-optimized AMI versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eproxyConfiguration.containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object. || \u003cstrong\u003eproxyConfiguration.properties.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erequiresCompatibilities\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe task launch type that Amazon ECS validates the task definition against.\u003cbr/\u003eA client exception is returned if the task definition doesn\u0026rsquo;t validate against\u003cbr/\u003ethe compatibilities specified. If no value is specified, the parameter is\u003cbr/\u003eomitted from the response. |\n| \u003cstrong\u003erequiresCompatibilities.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruntimePlatform\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe operating system that your tasks definitions run on. A platform family\u003cbr/\u003eis specified only for tasks using the Fargate launch type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you specify a task definition in a service, this value must match the\u003cbr/\u003eruntimePlatform value of the service. |\n| \u003cstrong\u003eruntimePlatform.cpuArchitecture\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruntimePlatform.operatingSystemFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the task definition to help you categorize\u003cbr/\u003eand organize them. Each tag consists of a key and an optional value. You\u003cbr/\u003edefine both of them.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe short name or full Amazon Resource Name (ARN) of the IAM role that containers\u003cbr/\u003ein this task can assume. All containers in this task are granted the permissions\u003cbr/\u003ethat are specified in this role. For more information, see IAM Roles for\u003cbr/\u003eTasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003etaskRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003etaskRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003etaskRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of volume definitions in JSON format that containers in your task\u003cbr/\u003emight use. |\n| \u003cstrong\u003evolumes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data volume configuration for tasks launched using this task definition.\nSpecifying a volume configuration in a task definition is optional. The volume\nconfiguration may contain multiple volumes but only one volume configured\nat launch is supported. Each volume defined in the volume configuration may\nonly specify a name and one of either configuredAtLaunch, dockerVolumeConfiguration,\nefsVolumeConfiguration, fsxWindowsFileServerVolumeConfiguration, or host.\nIf an empty volume configuration is specified, by default Amazon ECS uses\na host volume. For more information, see Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). || \u003cstrong\u003evolumes.[].configuredAtLaunch\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using Docker volumes. Docker volumes\u003cbr/\u003eare only supported when you\u0026rsquo;re using the EC2 launch type. Windows containers\u003cbr/\u003eonly support the use of the local driver. To use bind mounts, specify a host\u003cbr/\u003einstead. |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.autoprovision\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.driver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.driverOpts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.labels\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.scope\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using an Amazon Elastic File System\u003cbr/\u003efile system for task storage. For more information, see Amazon EFS volumes\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe authorization configuration details for the Amazon EFS file system. |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig.accessPointID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig.iam\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.rootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.transitEncryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.transitEncryptionPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using Amazon FSx for Windows File\u003cbr/\u003eServer (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html)\u003cbr/\u003efile system for task storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information and the input format, see Amazon FSx for Windows File\u003cbr/\u003eServer volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe authorization configuration details for Amazon FSx for Windows File Server\u003cbr/\u003efile system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html)\u003cbr/\u003ein the Amazon ECS API Reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information and the input format, see Amazon FSx for Windows File\u003cbr/\u003eServer Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig.credentialsParameter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig.domain\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.rootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].host\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on a container instance bind mount host volume. |\n| \u003cstrong\u003evolumes.[].host.sourcePath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncompatibilities:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nderegisteredAt: string\nregisteredAt: string\nregisteredBy: string\nrequiresAttributes:\n- name: string\n targetID: string\n targetType: string\n value: string\nrevision: integer\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibilities\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe task launch types the task definition validated against during task definition\u003cbr/\u003eregistration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibilities.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ederegisteredAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the task definition was deregistered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the task definition was registered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe principal that registered the task definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe container instance attributes required by your task. When an Amazon EC2\u003cbr/\u003einstance is registered to your cluster, the Amazon ECS container agent assigns\u003cbr/\u003esome standard attributes to the instance. You can apply custom attributes.\u003cbr/\u003eThese are specified as key-value pairs using the Amazon ECS console or the\u003cbr/\u003ePutAttributes API. These attributes are used when determining task placement\u003cbr/\u003efor tasks hosted on Amazon EC2 instances. For more information, see Attributes\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter isn\u0026rsquo;t supported for tasks run on Fargate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn attribute is a name-value pair that\u0026rsquo;s associated with an Amazon ECS object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse attributes to extend the Amazon ECS data model by adding custom metadata\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the Amazon Elastic Container Service Developer Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].targetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].targetType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe revision of the task in a particular family. The revision is a version\u003cbr/\u003enumber of a task definition in a family. When you register a task definition\u003cbr/\u003efor the first time, the revision is 1. Each time that you register a new\u003cbr/\u003erevision of a task definition in the same family, the revision value always\u003cbr/\u003eincreases by one. This is even if you deregistered previous revisions in\u003cbr/\u003ethis family.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the task definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:179,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/topic/",title:"Topic",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#Topic"\u003esns-controller/apis/v1alpha1#Topic\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTopic\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTopicList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etopics\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etopic\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA wrapper type for the topic\u0026rsquo;s Amazon Resource Name (ARN). To retrieve a\ntopic\u0026rsquo;s attributes, use GetTopicAttributes.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtentBasedDeduplication: string\ndataProtectionPolicy: string\ndeliveryPolicy: string\ndisplayName: string\nfifoTopic: string\nkmsMasterKeyID: string\nkmsMasterKeyRef: \n from: \n name: string\nname: string\npolicy: string\npolicyRef: \n from: \n name: string\nsignatureVersion: string\ntags:\n- key: string\n value: string\ntracingConfig: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentBasedDeduplication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProtectionPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe body of the policy document you want to use for this topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can only add one policy per topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe policy must be in JSON string format.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLength Constraints: Maximum length of 30,720.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efifoTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the topic you want to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Topic names must be made up of only uppercase and lowercase\u003cbr/\u003eASCII letters, numbers, underscores, and hyphens, and must be between 1 and\u003cbr/\u003e256 characters long.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esignatureVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of tags to add to a new topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to tag a topic on creation, you must have the sns:CreateTopic\u003cbr/\u003eand sns:TagResource permissions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of tags to be added to the specified topic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neffectiveDeliveryPolicy: string\nowner: string\ntopicARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeffectiveDeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:180,href:"https://aws-controllers-k8s.github.io/community/reference/cloudtrail/v1alpha1/trail/",title:"Trail",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudtrail.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudtrail-controller/apis/v1alpha1#Trail"\u003ecloudtrail-controller/apis/v1alpha1#Trail\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrail\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrailList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrails\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrail\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe settings for a trail.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecloudWatchLogsLogGroupARN: string\ncloudWatchLogsRoleARN: string\nenableLogFileValidation: boolean\nincludeGlobalServiceEvents: boolean\nisMultiRegionTrail: boolean\nisOrganizationTrail: boolean\nkmsKeyID: string\nname: string\ns3BucketName: string\ns3KeyPrefix: string\nsnsTopicName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudWatchLogsLogGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies a log group name using an Amazon Resource Name (ARN), a unique\u003cbr/\u003eidentifier that represents the log group to which CloudTrail logs will be\u003cbr/\u003edelivered. Not required unless you specify CloudWatchLogsRoleArn.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudWatchLogsRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the role for the CloudWatch Logs endpoint to assume to write to\u003cbr/\u003ea user\u0026rsquo;s log group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableLogFileValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether log file integrity validation is enabled. The default is\u003cbr/\u003efalse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you disable log file integrity validation, the chain of digest files\u003cbr/\u003eis broken after one hour. CloudTrail does not create digest files for log\u003cbr/\u003efiles that were delivered during a period in which log file integrity validation\u003cbr/\u003ewas disabled. For example, if you enable log file integrity validation at\u003cbr/\u003enoon on January 1, disable it at noon on January 2, and re-enable it at noon\u003cbr/\u003eon January 10, digest files will not be created for the log files delivered\u003cbr/\u003efrom noon on January 2 to noon on January 10. The same applies whenever you\u003cbr/\u003estop CloudTrail logging or delete a trail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eincludeGlobalServiceEvents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is publishing events from global services such\u003cbr/\u003eas IAM to the log files.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisMultiRegionTrail\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is created in the current region or in all regions.\u003cbr/\u003eThe default is false, which creates a trail only in the region where you\u003cbr/\u003eare signed in. As a best practice, consider creating trails that log events\u003cbr/\u003ein all regions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisOrganizationTrail\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is created for all accounts in an organization\u003cbr/\u003ein Organizations, or only for the current Amazon Web Services account. The\u003cbr/\u003edefault is false, and cannot be true unless the call is made on behalf of\u003cbr/\u003ean Amazon Web Services account that is the management account for an organization\u003cbr/\u003ein Organizations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.\u003cbr/\u003eThe value can be an alias name prefixed by \u0026ldquo;alias/\u0026rdquo;, a fully specified ARN\u003cbr/\u003eto an alias, a fully specified ARN to a key, or a globally unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCloudTrail also supports KMS multi-Region keys. For more information about\u003cbr/\u003emulti-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExamples:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * alias/MyAliasName\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the trail. The name must meet the following requirements:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\u003cbr/\u003e (_), or dashes (-)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Start with a letter or number, and end with a letter or number\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Be between 3 and 128 characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Have no adjacent periods, underscores or dashes. Names like my-_namespace\u003cbr/\u003e and my\u0026ndash;namespace are not valid.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Not be in IP address format (for example, 192.168.5.4)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003es3BucketName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the Amazon S3 bucket designated for publishing log\u003cbr/\u003efiles. See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003es3KeyPrefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the Amazon S3 key prefix that comes after the name of the bucket\u003cbr/\u003eyou have designated for log file delivery. For more information, see Finding\u003cbr/\u003eYour CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).\u003cbr/\u003eThe maximum length is 200 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the Amazon SNS topic defined for notification of log\u003cbr/\u003efile delivery. The maximum length is 256 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource such as a CloudTrail trail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlogFileValidationEnabled: boolean\nsnsTopicARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogFileValidationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether log file integrity validation is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\u003cbr/\u003ewhen log files are delivered. The format of a topic ARN is:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:sns:us-east-2:123456789012:MyTopic\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:181,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/trainingjob/",title:"TrainingJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#TrainingJob"\u003esagemaker-controller/apis/v1alpha1#TrainingJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrainingJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrainingJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrainingjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrainingjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a training job.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealgorithmSpecification: \n algorithmName: string\n enableSageMakerMetricsTimeSeries: boolean\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\ncheckpointConfig: \n localPath: string\n s3URI: string\ndebugHookConfig: \n collectionConfigurations:\n - collectionName: string\n collectionParameters: {}\n hookParameters: {}\n localPath: string\n s3OutputPath: string\ndebugRuleConfigurations:\n- instanceType: string\n localPath: string\n ruleConfigurationName: string\n ruleEvaluatorImage: string\n ruleParameters: {}\n s3OutputPath: string\n volumeSizeInGB: integer\nenableInterContainerTrafficEncryption: boolean\nenableManagedSpotTraining: boolean\nenableNetworkIsolation: boolean\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nhyperParameters: {}\ninfraCheckConfig: \n enableInfraCheck: boolean\ninputDataConfig:\n- channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\noutputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\nprofilerConfig: \n profilingIntervalInMilliseconds: integer\n profilingParameters: {}\n s3OutputPath: string\nprofilerRuleConfigurations:\n- instanceType: string\n localPath: string\n ruleConfigurationName: string\n ruleEvaluatorImage: string\n ruleParameters: {}\n s3OutputPath: string\n volumeSizeInGB: integer\nremoteDebugConfig: \n enableRemoteDebug: boolean\nresourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nretryStrategy: \n maximumRetryAttempts: integer\nroleARN: string\nstoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\ntags:\n- key: string\n value: string\ntensorBoardOutputConfig: \n localPath: string\n s3OutputPath: string\ntrainingJobName: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe registry path of the Docker image that contains the training algorithm\u003cbr/\u003eand algorithm-specific metadata, including the input mode. For more information\u003cbr/\u003eabout algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003eFor information about providing your own algorithms, see Using Your Own Algorithms\u003cbr/\u003ewith Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.algorithmName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.enableSageMakerMetricsTimeSeries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eYou can view these logs to understand how your training job performs and\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003echeck for any errors encountered during training. SageMaker hyperparameter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etuning captures all defined metrics. Specify one of the defined metrics to\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003euse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eparameter in the HyperParameterTrainingJobDefinition API to evaluate job\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eperformance during hyperparameter tuning.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions.[].regex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.trainingImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.trainingInputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for the Amazon SageMaker Debugger hook parameters,\u003cbr/\u003emetric and tensor collections, and storage paths. To learn more about how\u003cbr/\u003eto configure the DebugHookConfig parameter, see Use the SageMaker and Debugger\u003cbr/\u003eConfiguration API Operations to Create, Update, and Debug Your Training Job\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for the Amazon SageMaker Debugger output tensor\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecollections.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations.[].collectionParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.hookParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger rules for debugging\u003cbr/\u003eoutput tensors.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for SageMaker Debugger rules for debugging. To\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003elearn more about how to configure the DebugRuleConfiguration parameter, see\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse the SageMaker and Debugger Configuration API Operations to Create, Update,\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleEvaluatorImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTo encrypt all communications between ML compute instances in distributed\u003cbr/\u003etraining, choose True. Encryption provides greater security for distributed\u003cbr/\u003etraining, but training might take longer. How long it takes depends on the\u003cbr/\u003eamount of communication between compute instances, especially if you use\u003cbr/\u003ea deep learning algorithm in distributed training. For more information,\u003cbr/\u003esee Protect Communications Between ML Compute Instances in a Distributed\u003cbr/\u003eTraining Job (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableManagedSpotTraining\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTo train models using managed spot training, choose True. Managed spot training\u003cbr/\u003eprovides a fully managed and scalable infrastructure for training machine\u003cbr/\u003elearning models. this option is useful when training jobs can be interrupted\u003cbr/\u003eand when there is flexibility when the training job is run.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe complete and intermediate results of jobs are stored in an Amazon S3\u003cbr/\u003ebucket, and can be used as a starting point to train models incrementally.\u003cbr/\u003eAmazon SageMaker provides metrics and logs in CloudWatch. They can be used\u003cbr/\u003eto see when managed spot training jobs are running, interrupted, resumed,\u003cbr/\u003eor completed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIsolates the training container. No inbound or outbound network calls can\u003cbr/\u003ebe made, except for calls between peers within a training cluster for distributed\u003cbr/\u003etraining. If you enable network isolation for training jobs that are configured\u003cbr/\u003eto use a VPC, SageMaker downloads and uploads customer data and model artifacts\u003cbr/\u003ethrough the specified VPC, but the training container does not have network\u003cbr/\u003eaccess.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlgorithm-specific parameters that influence the quality of the model. You\u003cbr/\u003eset hyperparameters before you start the learning process. For a list of\u003cbr/\u003ehyperparameters for each training algorithm provided by SageMaker, see Algorithms\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can specify a maximum of 100 hyperparameters. Each hyperparameter is\u003cbr/\u003ea key-value pair. Each key and value is limited to 256 characters, as specified\u003cbr/\u003eby the Length Constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDo not include any security-sensitive information including account access\u003cbr/\u003eIDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive\u003cbr/\u003ecredentials are detected, SageMaker will reject your training job request\u003cbr/\u003eand return an exception error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einfraCheckConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the infrastructure health check configuration\u003cbr/\u003efor the training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einfraCheckConfig.enableInfraCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of Channel objects. Each channel is a named input source. InputDataConfig\u003cbr/\u003edescribes the input data and its location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlgorithms can accept input data from one or more channels. For example,\u003cbr/\u003ean algorithm might have two channels of input data, training_data and validation_data.\u003cbr/\u003eThe configuration for each channel provides the S3, EFS, or FSx location\u003cbr/\u003ewhere the input data is stored. It also provides information about the stored\u003cbr/\u003edata: the MIME type, compression method, and whether the data is wrapped\u003cbr/\u003ein RecordIO format.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDepending on the input mode that the algorithm supports, SageMaker either\u003cbr/\u003ecopies input data files from an S3 bucket to a local directory in the Docker\u003cbr/\u003econtainer, or makes it available as input streams. For example, if you specify\u003cbr/\u003ean EFS location, input data files are available as input streams. They do\u003cbr/\u003enot need to be downloaded.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input must be in the same Amazon Web Services region as your training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA channel is a named input source that training algorithms can consume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a file system data source for a channel.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.directoryPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.attributeNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.attributeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].inputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].recordWrapperType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].shuffleConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].shuffleConfig.seed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the path to the S3 location where you want to store model artifacts.\u003cbr/\u003eSageMaker creates subfolders for the artifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger system monitoring,\u003cbr/\u003eframework profiling, and storage paths.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.profilingIntervalInMilliseconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.profilingParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger rules for profiling\u003cbr/\u003esystem and framework metrics.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for profiling rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleEvaluatorImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteDebugConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for remote debugging. To learn more about the remote debugging\u003cbr/\u003efunctionality of SageMaker, see Access a training container through Amazon\u003cbr/\u003eWeb Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteDebugConfig.enableRemoteDebug\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe resources, including the ML compute instances and ML storage volumes,\u003cbr/\u003eto use for model training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eML storage volumes store model artifacts and incremental states. Training\u003cbr/\u003ealgorithms might also use ML storage volumes for scratch space. If you want\u003cbr/\u003eSageMaker to use the ML storage volume to store the training data, choose\u003cbr/\u003eFile as the TrainingInputMode in the algorithm specification. For distributed\u003cbr/\u003etraining algorithms, specify an instance count greater than 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPI, you can configure multiple instance groups .\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[].instanceGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.keepAlivePeriodInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe number of times to retry the job when the job fails due to an InternalServerError.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretryStrategy.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to\u003cbr/\u003eperform tasks on your behalf.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDuring model training, SageMaker needs your permission to read input data\u003cbr/\u003efrom an S3 bucket, download a Docker image that contains training code, write\u003cbr/\u003emodel artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and\u003cbr/\u003epublish metrics to Amazon CloudWatch. You grant permissions for all of these\u003cbr/\u003etasks to an IAM role. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a limit to how long a model training job can run. It also specifies\u003cbr/\u003ehow long a managed Spot training job has to complete. When the job reaches\u003cbr/\u003ethe time limit, SageMaker ends the training job. Use this API to cap model\u003cbr/\u003etraining costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\u003cbr/\u003ejob termination for 120 seconds. Algorithms can use this 120-second window\u003cbr/\u003eto save the model artifacts, so the results of training are not lost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxPendingTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eMaximum job scheduler pending time in seconds.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxWaitTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etensorBoardOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration of storage locations for the Amazon SageMaker Debugger TensorBoard\u003cbr/\u003eoutput data. |\n| \u003cstrong\u003etensorBoardOutputConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etensorBoardOutputConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the training job. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)\u003cbr/\u003eobject that specifies the VPC that you want your training job to connect\u003cbr/\u003eto. Control access to and from your training container by configuring the\u003cbr/\u003eVPC. For more information, see Protect Training Jobs by Using an Amazon Virtual\u003cbr/\u003ePrivate Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ndebugRuleEvaluationStatuses:\n- lastModifiedTime: string\n ruleConfigurationName: string\n ruleEvaluationJobARN: string\n ruleEvaluationStatus: string\n statusDetails: string\nfailureReason: string\nlastModifiedTime: string\nmodelArtifacts: \n s3ModelArtifacts: string\nprofilerRuleEvaluationStatuses:\n- lastModifiedTime: string\n ruleConfigurationName: string\n ruleEvaluationJobARN: string\n ruleEvaluationStatus: string\n statusDetails: string\nprofilingStatus: string\nsecondaryStatus: string\ntrainingJobStatus: string\nwarmPoolStatus: \n resourceRetainedBillableTimeInSeconds: integer\n reusedByJob: string\n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that indicates when the training job was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEvaluation status of Amazon SageMaker Debugger rules for debugging on a training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the status of the rule evaluation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleEvaluationJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleEvaluationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].statusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the training job failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that indicates when the status of the training job was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelArtifacts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the Amazon S3 location that is configured for storing model\u003cbr/\u003eartifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelArtifacts.s3ModelArtifacts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEvaluation status of Amazon SageMaker Debugger rules for profiling on a training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the status of the rule evaluation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleEvaluationJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleEvaluationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].statusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProfiling status of a training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecondaryStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides detailed information about the state of the training job. For detailed\u003cbr/\u003einformation on the secondary status of the training job, see StatusMessage\u003cbr/\u003eunder SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSageMaker provides primary statuses and secondary statuses that apply to\u003cbr/\u003eeach of them:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eInProgress\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Starting - Starting the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Downloading - An optional stage for algorithms that support File training\u003cbr/\u003e input mode. It indicates that data is being downloaded to the ML storage\u003cbr/\u003e volumes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Training - Training is in progress.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Interrupted - The job stopped because the managed spot training instances\u003cbr/\u003e were interrupted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Uploading - Training is complete and the model artifacts are being uploaded\u003cbr/\u003e to the S3 location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCompleted\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Completed - The training job has completed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFailed\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed - The training job has failed. The reason for the failure is\u003cbr/\u003e returned in the FailureReason field of DescribeTrainingJobResponse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStopped\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * MaxRuntimeExceeded - The job stopped because it exceeded the maximum\u003cbr/\u003e allowed runtime.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * MaxWaitTimeExceeded - The job stopped because it exceeded the maximum\u003cbr/\u003e allowed wait time.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopped - The training job has stopped.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStopping\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopping - Stopping the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for SecondaryStatus are subject to change.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe no longer support the following secondary statuses:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * LaunchingMLInstances\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PreparingTraining\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DownloadingTrainingImage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etrainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSageMaker provides the following training job statuses:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InProgress - The training is in progress.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Completed - The training job has completed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed - The training job has failed. To see the reason for the failure,\u003cbr/\u003e see the FailureReason field in the response to a DescribeTrainingJobResponse\u003cbr/\u003e call.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopping - The training job is stopping.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopped - The training job has stopped.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more detailed information, see SecondaryStatus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the warm pool associated with the training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.resourceRetainedBillableTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Indicates how many seconds the resource stayed in ResourceRetained\u003cbr/\u003estate. Populated only after resource reaches ResourceReused or ResourceReleased\u003cbr/\u003estate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.reusedByJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:182,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/transformjob/",title:"TransformJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#TransformJob"\u003esagemaker-controller/apis/v1alpha1#TransformJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransformJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransformJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransformjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransformjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA batch transform job. For information about SageMaker batch transform, see\nUse Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebatchStrategy: string\ndataProcessing: \n inputFilter: string\n joinSource: string\n outputFilter: string\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nmaxConcurrentTransforms: integer\nmaxPayloadInMB: integer\nmodelClientConfig: \n invocationsMaxRetries: integer\n invocationsTimeoutInSeconds: integer\nmodelName: string\ntags:\n- key: string\n value: string\ntransformInput: \n compressionType: string\n contentType: string\n dataSource: \n s3DataSource: \n s3DataType: string\n s3URI: string\n splitType: string\ntransformJobName: string\ntransformOutput: \n accept: string\n assembleWith: string\n kmsKeyID: string\n s3OutputPath: string\ntransformResources: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebatchStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the number of records to include in a mini-batch for an HTTP inference\u003cbr/\u003erequest. A record is a single unit of input data that inference can be made\u003cbr/\u003eon. For example, a single line in a CSV file is a record.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo enable the batch strategy, you must set the SplitType property to Line,\u003cbr/\u003eRecordIO, or TFRecord.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use only one record when making an HTTP invocation request to a container,\u003cbr/\u003eset BatchStrategy to SingleRecord and SplitType to Line.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo fit as many records in a mini-batch as can fit within the MaxPayloadInMB\u003cbr/\u003elimit, set BatchStrategy to MultiRecord and SplitType to Line.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data structure used to specify the data to be used for inference in a\u003cbr/\u003ebatch transform job and to associate the data that is relevant to the prediction\u003cbr/\u003eresults in the output. The input filter provided allows you to exclude input\u003cbr/\u003edata that is not needed for inference in a batch transform job. The output\u003cbr/\u003efilter provided allows you to include input data relevant to interpreting\u003cbr/\u003ethe predictions in the output from the job. For more information, see Associate\u003cbr/\u003ePrediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.inputFilter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.joinSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.outputFilter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container. We support up to\u003cbr/\u003e16 key and values entries in the map.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxConcurrentTransforms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of parallel requests that can be sent to each instance\u003cbr/\u003ein a transform job. If MaxConcurrentTransforms is set to 0 or left unset,\u003cbr/\u003eAmazon SageMaker checks the optional execution-parameters to determine the\u003cbr/\u003esettings for your chosen algorithm. If the execution-parameters endpoint\u003cbr/\u003eis not enabled, the default value is 1. For more information on execution-parameters,\u003cbr/\u003esee How Containers Serve Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests).\u003cbr/\u003eFor built-in algorithms, you don\u0026rsquo;t need to set a value for MaxConcurrentTransforms.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxPayloadInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum allowed size of the payload, in MB. A payload is the data portion\u003cbr/\u003eof a record (without metadata). The value in MaxPayloadInMB must be greater\u003cbr/\u003ethan, or equal to, the size of a single record. To estimate the size of a\u003cbr/\u003erecord in MB, divide the size of your dataset by the number of records. To\u003cbr/\u003eensure that the records fit within the maximum payload size, we recommend\u003cbr/\u003eusing a slightly larger value. The default value is 6 MB.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\u003cbr/\u003ethe MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms\u003cbr/\u003e* MaxPayloadInMB) also cannot exceed 100 MB.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor cases where the payload might be arbitrarily large and is transmitted\u003cbr/\u003eusing HTTP chunked encoding, set the value to 0. This feature works only\u003cbr/\u003ein supported algorithms. Currently, Amazon SageMaker built-in algorithms\u003cbr/\u003edo not support HTTP chunked encoding.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the timeout and maximum number of retries for processing a transform\u003cbr/\u003ejob invocation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig.invocationsMaxRetries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig.invocationsTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model that you want to use for the transform job. ModelName\u003cbr/\u003emust be the name of an existing Amazon SageMaker model within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the input source and the way the transform job consumes it. |\n| \u003cstrong\u003etransformInput.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source. |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.splitType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformJobName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the transform job. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. |\n| \u003cstrong\u003etransformOutput\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of the transform job. |\n| \u003cstrong\u003etransformOutput.accept\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.assembleWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including ML instance types and ML instance count,\u003cbr/\u003eto use for the transform job. |\n| \u003cstrong\u003etransformResources.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\ntransformJobStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the transform job failed, FailureReason describes why it failed. A transform\u003cbr/\u003ejob creates a log file, which includes error messages, and stores it as an\u003cbr/\u003eAmazon S3 object. For more information, see Log Amazon SageMaker Events with\u003cbr/\u003eAmazon CloudWatch (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransformJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the transform job. If the transform job failed, the reason\u003cbr/\u003eis returned in the FailureReason field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:183,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/transitgateway/",title:"TransitGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#TransitGateway"\u003eec2-controller/apis/v1alpha1#TransitGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransitGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransitGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransitgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransitgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a transit gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\noptions: \n amazonSideASN: integer\n autoAcceptSharedAttachments: string\n defaultRouteTableAssociation: string\n defaultRouteTablePropagation: string\n dnsSupport: string\n multicastSupport: string\n transitGatewayCIDRBlocks:\n - string\n vpnECMPSupport: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe transit gateway options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.amazonSideASN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.autoAcceptSharedAttachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.defaultRouteTableAssociation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.defaultRouteTablePropagation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.dnsSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.multicastSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.transitGatewayCIDRBlocks\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.transitGatewayCIDRBlocks.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nownerID: string\nstate: string\ntransitGatewayID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe creation time.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:184,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#User"\u003eelasticache-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessString: string\nengine: string\nnoPasswordRequired: boolean\npasswords:\n- key: string\n name: string\n namespace: string\ntags:\n- key: string\n value: string\nuserID: string\nuserName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessString\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current supported value is Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enoPasswordRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates a password is not required for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003ePasswords used for this user. You can create up to two passwords for each user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username of the user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nauthentication: \n passwordCount: integer\n type_: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nexpandedAccessString: string\nlastRequestedAccessString: string\nminimumEngineVersion: string\nstatus: string\nuserGroupIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDenotes whether the user requires a password to authenticate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication.passwordCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authentication.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexpandedAccessString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastRequestedAccessString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version required, which is Redis 6.0\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the user status. Can be \u0026ldquo;active\u0026rdquo;, \u0026ldquo;modifying\u0026rdquo; or \u0026ldquo;deleting\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReturns a list of the user group IDs the user belongs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:185,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#User"\u003eiam-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM user entity.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateUser\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetUser\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListUsers\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003einlinePolicies: {}\nname: string\npath: string\npermissionsBoundary: string\npermissionsBoundaryRef: \n from: \n name: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the user to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path for the user name. For more information about paths, see IAM identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the managed policy that is used to set the permissions boundary\u003cbr/\u003efor the user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA permissions boundary policy defines the maximum permissions that identity-based\u003cbr/\u003epolicies can grant to an entity, but does not grant permissions. Permissions\u003cbr/\u003eboundaries do not define the maximum permissions that a resource-based policy\u003cbr/\u003ecan grant to an entity. To learn more, see Permissions boundaries for IAM\u003cbr/\u003eentities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about policy types, see Policy types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new user. Each tag consists\u003cbr/\u003eof a key name and an associated value. For more information about tagging,\u003cbr/\u003esee Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\nwith an IAM resource. For more information about tagging, see Tagging IAM\nresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\nin the IAM User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\npasswordLastUsed: string\nuserID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the user was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswordLastUsed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the user\u0026rsquo;s password was last used to sign in to an Amazon Web Services\u003cbr/\u003ewebsite. For a list of Amazon Web Services websites that capture a user\u0026rsquo;s\u003cbr/\u003elast sign-in time, see the Credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html)\u003cbr/\u003etopic in the IAM User Guide. If a password is used more than once in a five-minute\u003cbr/\u003espan, only the first use is returned in this field. If the field is null\u003cbr/\u003e(no value), then it indicates that they never signed in with a password.\u003cbr/\u003eThis can be because:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The user never had a password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A password exists but has not been used since IAM started tracking this\u003cbr/\u003e information on October 20, 2014.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA null value does not mean that the user never had a password. Also, if the\u003cbr/\u003euser does not currently have a password but had one in the past, then this\u003cbr/\u003efield contains the date and time the most recent password was used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is returned only in the GetUser and ListUsers operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the user. For more information about\u003cbr/\u003eIDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:186,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#User"\u003ememorydb-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessString: string\nauthenticationMode: \n passwords:\n - key: string\n name: string\n namespace: string\n type_: string\nname: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessString\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDenotes the user\u0026rsquo;s authentication properties, such as whether it requires a password to authenticate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authenticationMode.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the user. This value must be unique as it also serves as the user identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\naclNames:\n- string\nauthentication: \n passwordCount: integer\n type_: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nminimumEngineVersion: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe names of the Access Control Lists to which the user belongs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication.passwordCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authentication.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version supported for the user\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the user status. Can be \u0026ldquo;active\u0026rdquo;, \u0026ldquo;modifying\u0026rdquo; or \u0026ldquo;deleting\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:187,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/usergroup/",title:"UserGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#UserGroup"\u003eelasticache-controller/apis/v1alpha1#UserGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eengine: string\ntags:\n- key: string\n value: string\nuserGroupID: string\nuserIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current supported value is Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of user IDs that belong to the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nminimumEngineVersion: string\npendingChanges: \n userIDsToAdd:\n - string\n userIDsToRemove:\n - string\nreplicationGroups:\n- string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version required, which is Redis 6.0\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of updates being applied to the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:188,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/userprofile/",title:"UserProfile",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#UserProfile"\u003esagemaker-controller/apis/v1alpha1#UserProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euserprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euserprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edomainID: string\nsingleSignOnUserIdentifier: string\nsingleSignOnUserValue: string\ntags:\n- key: string\n value: string\nuserProfileName: string\nuserSettings: \n codeEditorAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n customFileSystemConfigs:\n efsFileSystemConfig: \n fileSystemID: string\n fileSystemPath: string\n customPosixUserConfig: \n gid: integer\n uid: integer\n defaultLandingURI: string\n executionRole: string\n jupyterLabAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n jupyterServerAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n kernelGatewayAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n rStudioServerProAppSettings: \n accessStatus: string\n userGroup: string\n securityGroups:\n - string\n sharingSettings: \n notebookOutputOption: string\n s3KMSKeyID: string\n s3OutputPath: string\n spaceStorageSettings: \n defaultEBSStorageSettings: \n defaultEBSVolumeSizeInGb: integer\n maximumEBSVolumeSizeInGb: integer\n studioWebPortal: string\n tensorBoardAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the associated Domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esingleSignOnUserIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA specifier for the type of value specified in SingleSignOnUserValue. Currently,\u003cbr/\u003ethe only supported value is \u0026ldquo;UserName\u0026rdquo;. If the Domain\u0026rsquo;s AuthMode is IAM Identity\u003cbr/\u003eCenter, this field is required. If the Domain\u0026rsquo;s AuthMode is not IAM Identity\u003cbr/\u003eCenter, this field cannot be specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esingleSignOnUserValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username of the associated Amazon Web Services Single Sign-On User for\u003cbr/\u003ethis UserProfile. If the Domain\u0026rsquo;s AuthMode is IAM Identity Center, this field\u003cbr/\u003eis required, and must match a valid username of a user in your directory.\u003cbr/\u003eIf the Domain\u0026rsquo;s AuthMode is not IAM Identity Center, this field cannot be\u003cbr/\u003especified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEach tag consists of a key and an optional value. Tag keys must be unique\u003cbr/\u003eper resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags that you specify for the User Profile are also added to all Apps that\u003cbr/\u003ethe User Profile launches.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserProfileName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the UserProfile. This value is not case sensitive. |\n| \u003cstrong\u003euserSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings. |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Code Editor application settings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Code Editor, see Get started with Code Editor\u003cbr/\u003ein Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html). |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.customFileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom file system to a user profile or space\nfor an Amazon SageMaker Domain. Permitted users can access this file system\nin Amazon SageMaker Studio. || \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom Amazon EFS file system to a user profile\u003cbr/\u003eor space for an Amazon SageMaker Domain. |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customPosixUserConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the POSIX identity that is used for file system operations. |\n| \u003cstrong\u003euserSettings.customPosixUserConfig.gid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customPosixUserConfig.uid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.defaultLandingURI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.executionRole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for the JupyterLab application. |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\nimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). || \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].appImageConfigName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.jupyterServerAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe JupyterServer app settings. |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.kernelGatewayAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe KernelGateway app settings. |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\nimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). || \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].appImageConfigName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.rStudioServerProAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings that configure user interaction with the RStudioServerPro\u003cbr/\u003eapp. |\n| \u003cstrong\u003euserSettings.rStudioServerProAppSettings.accessStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.rStudioServerProAppSettings.userGroup\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.sharingSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies options for sharing Amazon SageMaker Studio notebooks. These settings\u003cbr/\u003eare specified as part of DefaultUserSettings when the CreateDomain API is\u003cbr/\u003ecalled, and as part of UserSettings when the CreateUserProfile API is called.\u003cbr/\u003eWhen SharingSettings is not specified, notebook sharing isn\u0026rsquo;t allowed. |\n| \u003cstrong\u003euserSettings.sharingSettings.notebookOutputOption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.sharingSettings.s3KMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.sharingSettings.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.spaceStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default storage settings for a private space. |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of default EBS storage settings that applies to private spaces\u003cbr/\u003ecreated within a domain or user profile. |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.studioWebPortal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TensorBoard app settings. |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:189,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/version/",title:"Version",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Version"\u003elambda-controller/apis/v1alpha1#Version\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVersion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVersionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eversions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eversion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecodeSHA256: string\ndescription: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nprovisionedConcurrencyConfig: \n functionName: string\n provisionedConcurrentExecutions: integer\n qualifier: string\nrevisionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSHA256\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOnly publish a version if the hash value matches the value that\u0026rsquo;s specified.\u003cbr/\u003eUse this option to avoid publishing a version if the function code has changed\u003cbr/\u003esince you last updated it. You can get the hash for the version that you\u003cbr/\u003euploaded from the output of UpdateFunctionCode.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the version to override the description in the function\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name - MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN - 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.provisionedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOnly update the function if the revision ID matches the ID that\u0026rsquo;s specified.\u003cbr/\u003eUse this option to avoid publishing a version if the function configuration\u003cbr/\u003ehas changed since you last updated it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\narchitectures:\n- string\ncodeSize: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndeadLetterConfig: \n targetARN: string\nenvironment: \n error: \n errorCode: string\n message: string\n variables: {}\nephemeralStorage: \n size: integer\nfileSystemConfigs:\n- arn: string\n localMountPath: string\nfunctionARN: string\nhandler: string\nimageConfigResponse: \n error: \n errorCode: string\n message: string\n imageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nkmsKeyARN: string\nlastModified: string\nlastUpdateStatus: string\nlastUpdateStatusReason: string\nlastUpdateStatusReasonCode: string\nlayers:\n- arn: string\n codeSize: integer\n signingJobARN: string\n signingProfileVersionARN: string\nmasterARN: string\nmemorySize: integer\npackageType: string\nqualifier: string\nrole: string\nruntime: string\nsigningJobARN: string\nsigningProfileVersionARN: string\nsnapStart: \n applyOn: string\n optimizationStatus: string\nstate: string\nstateReason: string\nstateReasonCode: string\ntimeout: integer\ntracingConfig: \n mode: string\nversion: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnetIDs:\n - string\n vpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe instruction set architecture that the function supports. Architecture\u003cbr/\u003eis a string array with one of the valid values. The default architecture\u003cbr/\u003evalue is x86_64.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s dead letter queue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig.targetARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).\u003cbr/\u003eOmitted from CloudTrail logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError messages for environment variables that couldn\u0026rsquo;t be applied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.variables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe size of the function’s /tmp directory in MB. The default value is 512,\u003cbr/\u003ebut it can be any whole number between 512 and 10,240 MB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConnection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the connection between a Lambda function and an Amazon EFS\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[].localMountPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s Amazon Resource Name (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehandler\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function that Lambda calls to begin running your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s image configuration values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError response to GetFunctionConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration values that override the container image Dockerfile settings.\u003cbr/\u003eFor more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key that\u0026rsquo;s used to encrypt the function\u0026rsquo;s environment variables.\u003cbr/\u003eThis key is returned only if you\u0026rsquo;ve configured a customer managed key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the function was last updated, in ISO-8601 format\u003cbr/\u003e(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the last update that was performed on the function. This is\u003cbr/\u003efirst set to Successful after function creation completes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].codeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].signingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].signingProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor Lambda@Edge functions, the ARN of the main function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememorySize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of memory available to the function at runtime.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epackageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of deployment package. Set to Image for container image and set\u003cbr/\u003eZip for .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equalifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s execution role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruntime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe runtime environment for the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing profile version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSet ApplyOn to PublishedVersions to create a snapshot of the initialized\u003cbr/\u003eexecution environment when you publish a function version. For more information,\u003cbr/\u003esee Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.applyOn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.optimizationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the function. When the state is Inactive, you can reactivate\u003cbr/\u003ethe function by invoking it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the function\u0026rsquo;s current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the function\u0026rsquo;s current state. When the code is Creating,\u003cbr/\u003eyou can\u0026rsquo;t invoke or modify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of time in seconds that Lambda allows a function to run before\u003cbr/\u003estopping it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s X-Ray tracing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s networking configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:190,href:"https://aws-controllers-k8s.github.io/community/reference/emrcontainers/v1alpha1/virtualcluster/",title:"VirtualCluster",description:null,content:'\u003cp\u003e\u003ccode\u003eemrcontainers.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/emrcontainers-controller/apis/v1alpha1#VirtualCluster"\u003eemrcontainers-controller/apis/v1alpha1#VirtualCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVirtualCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVirtualClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evirtualclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evirtualcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis entity describes a virtual cluster. A virtual cluster is a Kubernetes\nnamespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters\nto run jobs and host endpoints. Multiple virtual clusters can be backed by\nthe same physical cluster. However, each virtual cluster maps to one namespace\non an EKS cluster. Virtual clusters do not create any active resources that\ncontribute to your bill or that require lifecycle management outside the\nservice.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainerProvider: \n id: string\n info: \n eksInfo: \n namespace: string\n type_: string\nname: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container provider of the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about the container used for a job run or a managed endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info.eksInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about the EKS cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info.eksInfo.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**containerProvider.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe specified name of the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tags assigned to the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis output contains the virtual cluster ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:191,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpc/",title:"VPC",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPC"\u003eec2-controller/apis/v1alpha1#VPC\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPC\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpc\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamazonProvidedIPv6CIDRBlock: boolean\ncidrBlocks:\n- string\nenableDNSHostnames: boolean\nenableDNSSupport: boolean\ninstanceTenancy: string\nipv4IPAMPoolID: string\nipv4NetmaskLength: integer\nipv6CIDRBlock: string\nipv6CIDRBlockNetworkBorderGroup: string\nipv6IPAMPoolID: string\nipv6NetmaskLength: integer\nipv6Pool: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonProvidedIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for\u003cbr/\u003ethe VPC. You cannot specify the range of IP addresses, or the size of the\u003cbr/\u003eCIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlocks\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlocks.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableDNSSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe attribute value. The valid values are true or false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTenancy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe tenancy options for instances launched into the VPC. For default, instances\u003cbr/\u003eare launched with shared tenancy by default. You can launch instances with\u003cbr/\u003eany tenancy into a shared tenancy VPC. For dedicated, instances are launched\u003cbr/\u003eas dedicated tenancy instances by default. You can only launch instances\u003cbr/\u003ewith a tenancy of dedicated or host into a dedicated tenancy VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eImportant: The host value cannot be used with this parameter. Use the default\u003cbr/\u003eor dedicated values only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: default\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv4IPAMPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv4 IPAM pool you want to use for allocating this VPC\u0026rsquo;s CIDR.\u003cbr/\u003eFor more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv4NetmaskLength\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe netmask length of the IPv4 CIDR you want to allocate to this VPC from\u003cbr/\u003ean Amazon VPC IP Address Manager (IPAM) pool. For more information about\u003cbr/\u003eIPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool\u003cbr/\u003ein the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo let Amazon choose the IPv6 CIDR block for you, omit this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockNetworkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the location from which we advertise the IPV6 CIDR block. Use\u003cbr/\u003ethis parameter to limit the address to this location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must set AmazonProvidedIpv6CidrBlock to true to use this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6IPAMPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6\u003cbr/\u003eCIDR. IPAM is a VPC feature that you can use to automate your IP address\u003cbr/\u003emanagement workflows including assigning, tracking, troubleshooting, and\u003cbr/\u003eauditing IP addresses across Amazon Web Services Regions and accounts throughout\u003cbr/\u003eyour Amazon Web Services Organization. For more information, see What is\u003cbr/\u003eIPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6NetmaskLength\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe netmask length of the IPv6 CIDR you want to allocate to this VPC from\u003cbr/\u003ean Amazon VPC IP Address Manager (IPAM) pool. For more information about\u003cbr/\u003eIPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncidrBlockAssociationSet:\n- associationID: string\n cidrBlock: string\n cidrBlockState: \n state: string\n statusMessage: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndhcpOptionsID: string\nipv6CIDRBlockAssociationSet:\n- associationID: string\n ipv6CIDRBlock: string\n ipv6CIDRBlockState: \n state: string\n statusMessage: string\n ipv6Pool: string\n networkBorderGroup: string\nisDefault: boolean\nownerID: string\nstate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv4 CIDR blocks associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block associated with a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpOptionsID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the set of DHCP options you\u0026rsquo;ve associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv6 CIDR blocks associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block associated with a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].networkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisDefault\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the VPC is the default VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:192,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcendpoint/",title:"VPCEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCEndpoint"\u003eec2-controller/apis/v1alpha1#VPCEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC endpoint.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ednsOptions: \n dnsRecordIPType: string\nipAddressType: string\npolicyDocument: string\nprivateDNSEnabled: boolean\nrouteTableIDs:\n- string\nrouteTableRefs:\n from: \n name: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nserviceName: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\nvpcEndpointType: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe DNS options for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsOptions.dnsRecordIPType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddressType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IP address type for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyDocument\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(Interface and gateway endpoints) A policy to attach to the endpoint that\u003cbr/\u003econtrols access to the service. The policy must be in valid JSON format.\u003cbr/\u003eIf this parameter is not specified, we attach a default policy that allows\u003cbr/\u003efull access to the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) Indicates whether to associate a private hosted zone\u003cbr/\u003ewith the specified VPC. The private hosted zone contains a record set for\u003cbr/\u003ethe default public DNS name for the service for the Region (for example,\u003cbr/\u003ekinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses\u003cbr/\u003eof the endpoint network interfaces in the VPC. This enables you to make requests\u003cbr/\u003eto the default public DNS name for the service instead of the public DNS\u003cbr/\u003enames that are automatically generated by the VPC endpoint service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a private hosted zone, you must set the following VPC attributes to\u003cbr/\u003etrue: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to\u003cbr/\u003eset the VPC attributes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: true\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Gateway endpoint) One or more route table IDs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) The ID of one or more security groups to associate with\u003cbr/\u003ethe endpoint network interface. |\n| \u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe service name. To get a list of available services, use the DescribeVpcEndpointServices\u003cbr/\u003erequest, or get the name from the service provider. |\n| \u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets\u003cbr/\u003ein which to create an endpoint network interface. For a Gateway Load Balancer\u003cbr/\u003eendpoint, you can specify one subnet only. |\n| \u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcEndpointType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Gateway |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC in which the endpoint will be used. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTimestamp: string\ndnsEntries:\n- dnsName: string\n hostedZoneID: string\ngroups:\n- groupID: string\n groupName: string\nlastError: \n code: string\n message: string\nnetworkInterfaceIDs:\n- string\nownerID: string\nrequesterManaged: boolean\nstate: string\nvpcEndpointID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) The DNS entries for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a DNS entry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries.[].hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) Information about the security groups that are associated\u003cbr/\u003ewith the network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe last error that occurred for endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) One or more network interfaces for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the endpoint is being managed by its service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:193,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/",title:"VPCEndpointServiceConfiguration",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCEndpointServiceConfiguration"\u003eec2-controller/apis/v1alpha1#VPCEndpointServiceConfiguration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointServiceConfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointServiceConfigurationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpointserviceconfigurations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpointserviceconfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceptanceRequired: boolean\nallowedPrincipals:\n- string\ngatewayLoadBalancerARNs:\n- string\nnetworkLoadBalancerARNs:\n- string\nprivateDNSName: string\nsupportedIPAddressTypes:\n- string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceptanceRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether requests from service consumers to create an endpoint to\u003cbr/\u003eyour service must be accepted manually.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPrincipals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Names (ARN) of one or more principals. Permissions are\u003cbr/\u003egranted to the principals in this list. To grant permissions to all principals,\u003cbr/\u003especify an asterisk (*).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPrincipals.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egatewayLoadBalancerARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkLoadBalancerARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedIPAddressTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe supported IP address types. The possible values are ipv4 and ipv6.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedIPAddressTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZones:\n- string\nbaseEndpointDNSNames:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nmanagesVPCEndpoints: boolean\npayerResponsibility: string\nprivateDNSNameConfiguration: \n name: string\n state: string\n type_: string\n value: string\nserviceID: string\nserviceName: string\nserviceState: string\nserviceType:\n- serviceType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Availability Zones in which the service is available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebaseEndpointDNSNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanagesVPCEndpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the service manages its VPC endpoints. Management of the\u003cbr/\u003eservice VPC endpoints using the VPC endpoint API is restricted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epayerResponsibility\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe payer responsibility.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the endpoint service private DNS name configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**privateDNSNameConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe service state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe type of service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceType.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the type of service for a VPC endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:194,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/vpclink/",title:"VPCLink",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#VPCLink"\u003eapigatewayv2-controller/apis/v1alpha1#VPCLink\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCLink\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCLinkList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpclinks\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpclink\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a VPC link.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nsecurityGroupIDs:\n- string\nsubnetIDs:\n- string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nvpcLinkID: string\nvpcLinkStatus: string\nvpcLinkStatusMessage: string\nvpcLinkVersion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:195,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcpeeringconnection/",title:"VPCPeeringConnection",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCPeeringConnection"\u003eec2-controller/apis/v1alpha1#VPCPeeringConnection\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCPeeringConnection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCPeeringConnectionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcpeeringconnections\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcpeeringconnection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC peering connection.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceptRequest: boolean\naccepterPeeringConnectionOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\npeerOwnerID: string\npeerRegion: string\npeerVPCID: string\npeerVPCRef: \n from: \n name: string\nrequesterPeeringConnectionOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceptRequest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe VPC peering connection options for the accepter VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerOwnerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID of the owner of the accepter VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Your Amazon Web Services account ID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Region code for the accepter VPC, if the accepter VPC is located in a\u003cbr/\u003eRegion other than the Region in which you make the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The Region in which you make the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC with which you are creating the VPC peering connection.\u003cbr/\u003eYou must specify this parameter in the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe VPC peering connection options for the requester VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the requester VPC. You must specify this parameter in the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccepterVPCInfo: \n cidrBlock: string\n cidrBlockSet:\n - cidrBlock: string\n ipv6CIDRBlockSet:\n - ipv6CIDRBlock: string\n ownerID: string\n peeringOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\n region: string\n vpcID: string\nackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nexpirationTime: string\nrequesterVPCInfo: \n cidrBlock: string\n cidrBlockSet:\n - cidrBlock: string\n ipv6CIDRBlockSet:\n - ipv6CIDRBlock: string\n ownerID: string\n peeringOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\n region: string\n vpcID: string\nstatus: \n code: string\n message: string\nvpcPeeringConnectionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the accepter VPC. CIDR block information is only returned\u003cbr/\u003ewhen describing an active VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ipv6CIDRBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ipv6CIDRBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\u003cbr/\u003efrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\u003cbr/\u003eto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDescribes the VPC peering connection options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexpirationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that an unaccepted VPC peering connection will expire.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the requester VPC. CIDR block information is only returned\u003cbr/\u003ewhen describing an active VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ipv6CIDRBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ipv6CIDRBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\u003cbr/\u003efrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\u003cbr/\u003eto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDescribes the VPC peering connection options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:196,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/workspace/",title:"Workspace",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#Workspace"\u003eprometheusservice-controller/apis/v1alpha1#Workspace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eWorkspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eWorkspaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eworkspaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eworkspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealias: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional user-assigned alias for this workspace. This alias is for user\u003cbr/\u003ereference and does not need to be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional, user-provided tags for this workspace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: \n statusCode: string\nworkspaceID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the workspace that was just created (usually CREATING).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eState of a workspace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe generated ID of the workspace that was just created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}),userinput.addEventListener('input',b,!0),suggestions.addEventListener('click',c,!0);function b(){var d,e;const c=5;d=this.value,e=a.search(d,{limit:c,enrich:!0}),suggestions.classList.remove('d-none'),suggestions.innerHTML="";const b={};e.forEach(a=>{a.result.forEach(a=>{b[a.doc.href]=a.doc})});for(const d in b){const e=b[d],a=document.createElement('div');if(a.innerHTML='<a href><span></span><span></span></a>',a.querySelector('a').href=d,a.querySelector('span:first-child').textContent=e.title,a.querySelector('span:nth-child(2)').textContent=e.description,suggestions.appendChild(a),suggestions.childElementCount==c)break}}function c(){while(suggestions.lastChild)suggestions.removeChild(suggestions.lastChild);return!1}})() \ No newline at end of file +var suggestions=document.getElementById('suggestions'),userinput=document.getElementById('userinput');document.addEventListener('keydown',inputFocus);function inputFocus(a){a.keyCode===191&&(a.preventDefault(),userinput.focus()),a.keyCode===27&&(userinput.blur(),suggestions.classList.add('d-none'))}document.addEventListener('click',function(a){var b=suggestions.contains(a.target);b||suggestions.classList.add('d-none')}),document.addEventListener('keydown',suggestionFocus);function suggestionFocus(b){const d=suggestions.querySelectorAll('a'),e=[...d],a=e.indexOf(document.activeElement);let c=0;b.keyCode===38?(b.preventDefault(),c=a>0?a-1:0,d[c].focus()):b.keyCode===40&&(b.preventDefault(),c=a+1<e.length?a+1:a,d[c].focus())}(function(){var a=new FlexSearch.Document({tokenize:"forward",cache:100,document:{id:'id',store:["href","title","description"],index:["title","description","content"]}});a.add({id:0,href:"https://aws-controllers-k8s.github.io/community/docs/community/background/",title:"Background",description:"History of the ACK project",content:'\u003cp\u003eIn 10/2018 Chris Hein \u003ca href="https://aws.amazon.com/blogs/opensource/aws-service-operator-kubernetes-available/"\u003eintroduced\u003c/a\u003e the AWS Service Operator (ASO) project. We reviewed the feedback from the community and stakeholders and in 08/2019 \u003ca href="https://github.com/aws/containers-roadmap/issues/456"\u003edecided\u003c/a\u003e to relaunch ASO as a first-tier open source project with concrete commitments from the container service team. In this process, we renamed the project to AWS Controllers for Kubernetes (ACK).\u003c/p\u003e\n\u003cp\u003eThe tenets for the relaunch were:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eACK is a community-driven project, based on a governance model defining roles and responsibilities.\u003c/li\u003e\n\u003cli\u003eACK is optimized for production usage with full test coverage including performance and scalability test suites.\u003c/li\u003e\n\u003cli\u003eACK strives to be the only codebase exposing AWS services via a Kubernetes operator.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eSince then, we worked on \u003ca href="https://github.com/aws/aws-controllers-k8s/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adesign"\u003edesign issues\u003c/a\u003e and gathering feedback around which services to prioritize.\u003c/p\u003e\n\u003ch2 id="existing-custom-controllers"\u003eExisting custom controllers\u003c/h2\u003e\n\u003cp\u003eAWS service teams use custom controllers, webhooks, and operators for different use cases and based on different approaches. Examples include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-sagemaker-operator-for-k8s"\u003eSageMaker operator\u003c/a\u003e, allowing to use SageMaker from Kubernetes\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/aws-app-mesh-controller-for-k8s"\u003eApp Mesh controller\u003c/a\u003e, managing App Mesh resources from Kubernetes\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook"\u003eEKS Pod Identity Webhook\u003c/a\u003e, providing IAM roles for service accounts functionality\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eWhile the autonomy in the different teams and project allows for rapid iterations and innovations, there are some drawbacks associated with it:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe UX differs and that can lead to frustration when adopting an offering.\u003c/li\u003e\n\u003cli\u003eA consistent quality bar across the different offerings is hard to establish and to verify.\u003c/li\u003e\n\u003cli\u003eIt\u0026rsquo;s wasteful to re-invent the plumbing and necessary infrastructure (testing, etc.).\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eAbove is the motivation for our 3rd tenet: we want to make sure that there is a common framework, implementing good practices as put forward, for example, in the \u003ca href="https://operators.gitbook.io/operator-developer-guide-for-red-hat-partners/"\u003eOperator Developer Guide\u003c/a\u003e or in the \u003ca href="https://programming-kubernetes.info/"\u003eProgramming Kubernetes\u003c/a\u003e book.\u003c/p\u003e\n\u003ch2 id="related-projects"\u003eRelated projects\u003c/h2\u003e\n\u003cp\u003eOutside of AWS, there are projects that share similar goals we have with the ASO, for example:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/crossplane/provider-aws"\u003eCrossplane\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/yard-turkey/aws-s3-provisioner"\u003eaws-s3-provisioner\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:1,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/overview/",title:"Contribution Overview",description:"Context on the contributor documentation",content:'\u003cp\u003eThis section of the docs is for contributors to the AWS Controllers for\nKubernetes (ACK) project.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re interested in enhancing our platform, developing on a specific\nservice controller or just curious how ACK is architected, you\u0026rsquo;ve come to the\nright place.\u003c/p\u003e\n\u003ch2 id="project-tenets-unless-you-know-better-ones"\u003eProject Tenets (unless you know better ones)\u003c/h2\u003e\n\u003cp\u003eWe follow a set of tenets in building AWS Controllers for Kubernetes.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eCollaborate in the Open\u003c/strong\u003e: Our source code is open. Our development\nmethodology is open. Our testing, release and documentation processes are\nopen. We are a community-driven project that strives to meet our users where\nthey are.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eGenerate Everything\u003c/strong\u003e: We choose to generate as much of our code as\npossible. Generated code is easier to maintain and encourages consistency.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eFocus on Kubernetes\u003c/strong\u003e: We seek ways to make the Kubernetes user experience\nas simple and consistent as possible for managing AWS resources.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eRun Anywhere\u003c/strong\u003e: ACK service controllers can be installed on any Kubernetes\ncluster, regardless of whether a user chooses to use Amazon Elastic\nKubernetes Service (EKS).\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003cstrong\u003eMinimize Service Dependencies\u003c/strong\u003e: The only AWS services that ACK service\ncontrollers depend on should be IAM/STS and the specific AWS service that\nthe controller integrates with. We do not take a dependency on any stateful\nresource-tracking service.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eRead more about our \u003ca href="../tenets/"\u003eproject tenets and design principles\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="code-organization"\u003eCode Organization\u003c/h2\u003e\n\u003cp\u003eACK is a collection of source repositories containing a common runtime and type\nsystem, a code generator and individual service controllers that manage\nresources in a specific AWS API.\u003c/p\u003e\n\u003cp\u003eLearn more about how our \u003ca href="../code-organization/"\u003esource code repositories are organized\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="api-inference"\u003eAPI Inference\u003c/h2\u003e\n\u003cp\u003eRead about \u003ca href="../api-inference/"\u003ehow the code generator infers\u003c/a\u003e information about a\nKubernetes Custom Resource Definitions (CRDs) from an AWS API model file.\u003c/p\u003e\n\u003ch2 id="code-generation"\u003eCode Generation\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="../code-generation/"\u003ecode generation\u003c/a\u003e section gives you a bit of background\non how we go about automating the code generation for controllers and supporting\nartifacts.\u003c/p\u003e\n\u003ch2 id="setting-up-a-development-environemnt"\u003eSetting up a Development Environemnt\u003c/h2\u003e\n\u003cp\u003eIn the \u003ca href="../setup/"\u003esetup\u003c/a\u003e section we walk you through setting up your local Git\nenvironment with the repo and how advise you on how we handle contributions.\u003c/p\u003e\n\u003ch2 id="building-an-ack-service-controller"\u003eBuilding an ACK Service Controller\u003c/h2\u003e\n\u003cp\u003eAfter getting your development environment established, you will want to learn\n\u003ca href="../building-controller"\u003ehow to build an ACK service controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="testing-an-ack-service-controller"\u003eTesting an ACK Service Controller\u003c/h2\u003e\n\u003cp\u003eLast but not least, in the \u003ca href="../testing/"\u003etesting\u003c/a\u003e section we show you how to\ntest ACK locally.\u003c/p\u003e\n'}).add({id:2,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/install/",title:"Install an ACK Controller",description:"Install an ACK Controller",content:'\u003cp\u003eThe following guide will walk you through the installation of an \u003ca href="../../community/services/"\u003eACK service controller\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIndividual ACK service controllers may be in different maintenance phases and follow separate release cadences. Please check the \u003ca href="../../community/releases/#project-stages"\u003eproject stages\u003c/a\u003e and \u003ca href="../../community/releases/#maintenance-phases"\u003emaintenance phases\u003c/a\u003e of the ACK service controllers you wish to install, including how controllers are \u003ca href="../../community/releases/#releases-and-versioning"\u003ereleased and versioned\u003c/a\u003e. Controllers in a preview maintenance phase have at least one container image and Helm chart released to a public repository.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Be mindful of maintenance phases\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Check the \u003ca href="../../community/releases/#project-stages"\u003eproject stage\u003c/a\u003e and \u003ca href="../../community/releases/#maintenance-phases"\u003emaintenance phase\u003c/a\u003e of the ACK service controller you wish to install. Be aware that controllers in a preview maintenance phase may have significant and breaking changes introduced in a future release.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="install-an-ack-service-controller-with-helm-recommended"\u003eInstall an ACK service controller with Helm (Recommended)\u003c/h2\u003e\n\u003cp\u003eThe recommended way to install an ACK service controller for Kubernetes is to use \u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eEach ACK service controller has a separate Helm chart that installs the necessary supporting artifacts as a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e. This includes the ACK service controller, custom resource definitions (CRDs), and Kubernetes Role-Based Access Control (RBAC) manifests.\u003c/p\u003e\n\u003cp\u003eHelm charts for ACK service controllers can be found in the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s"\u003eACK registry within the Amazon ECR Public Gallery\u003c/a\u003e. To find a Helm chart for a specific service, you can go to \u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/$SERVICENAME-chart\u003c/code\u003e. For example, the link to the ACK service controller Helm chart for Amazon Simple Storage Service (Amazon S3) is \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-chart"\u003e\u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/s3-chart\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eHelm charts for individual ACK service controllers are tagged with their release version. You can find charts for different releases under the \u003ccode\u003eImage tags\u003c/code\u003e section in the chart repository on the ECR Public Gallery.\u003c/p\u003e\n\u003cp\u003eBefore installing a Helm chart, you can query the controller repository to find the latest release tag. This tag will correspond with a version of the Helm chart and a controller image. Then, you can use the Helm CLI to log into the ECR public Helm registry and install the chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nexport ACK_SYSTEM_NAMESPACE=ack-system\nexport AWS_REGION=us-west-2\n\naws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller \\\n oci://public.ecr.aws/aws-controllers-k8s/$SERVICE-chart --version=$RELEASE_VERSION --set=aws.region=$AWS_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Specify a release version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The commands above download the latest version of the S3 controller. To select a\ndifferent version, change the \u003ccode\u003eRELEASE_VERSION\u003c/code\u003e variable and execute the commands again.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Specify your target service region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The commands above set the target service region of the S3 controller to \u003ccode\u003eus-west-2\u003c/code\u003e. Be sure to specify your target service region in the \u003ccode\u003eAWS_REGION\u003c/code\u003e variable. This will be the \u003cem\u003edefault\u003c/em\u003e AWS region in which resources will be created by the ACK service controller. Note that a single ACK service controller can manage the lifecycle of resources in multiple AWS regions: simply add the \u003ccode\u003eservices.k8s.aws/region=$REGION\u003c/code\u003e annotation to your resource. Alternately, you can add the \u003ccode\u003eservices.k8s.aws/region=$REGION\u003c/code\u003e annotation to a Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e and any resource launched in that \u003ccode\u003eNamespace\u003c/code\u003e will be created in that region by default.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe \u003ccode\u003ehelm install\u003c/code\u003e command should return relevant installation information:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME: ack-s3-controller\nLAST DEPLOYED: Thu Jun 16 19:30:16 2022\nNAMESPACE: ack-system\nSTATUS: deployed\nREVISION: 1\nTEST SUITE: None\nNOTES: ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo verify that the Helm chart was installed, use the \u003ccode\u003ehelm list\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm list --namespace $ACK_SYSTEM_NAMESPACE -o yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003ehelm list\u003c/code\u003e command should return your newly-deployed Helm chart release information:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eapp_version: 0.1.1\nchart: s3-chart-0.1.1\nname: ack-s3-controller\nnamespace: ack-system\nrevision: \u0026quot;1\u0026quot;\nstatus: deployed\nupdated: 2022-06-16 19:30:16.260012435 +0000 UTC\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-important"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n NOTE\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The \u003ccode\u003es3-controller\u003c/code\u003e should be installed now, but it is NOT yet fully functional.\nACK controllers need access to AWS IAM credentials to manage AWS resources.\nSee \u003ca href="#Next-steps"\u003eNext Steps\u003c/a\u003e for configuring AWS IAM credentials for ACK controller.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="install-an-ack-service-controller-with-static-kubernetes-manifests"\u003eInstall an ACK service controller with static Kubernetes manifests\u003c/h2\u003e\n\u003cp\u003eIf you prefer not to use Helm, you may install an ACK service controller using static Kubernetes manifests that are included in the source repository.\u003c/p\u003e\n\u003cp\u003eStatic Kubernetes manifests install an individual service controller as a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e, including the relevant Kubernetes RBAC resources. Static Kubernetes manifests are available in the \u003ccode\u003econfig/\u003c/code\u003e directory of the associated ACK service controller\u0026rsquo;s source repository.\u003c/p\u003e\n\u003cp\u003eFor example, the static manifests needed to install the S3 service controller for ACK are available in the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/tree/main/config"\u003e\u003ccode\u003econfig/\u003c/code\u003e\u003c/a\u003e directory in the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003eS3 controller\u0026rsquo;s source repository\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="install-an-ack-service-controller-with-operatorhub-in-red-hat-openshift"\u003eInstall an ACK service controller with OperatorHub in Red Hat OpenShift\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-important"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Please reference the \u003ca href="../openshift"\u003eOpenshift\u003c/a\u003e page for necessary pre-installation steps before installing any ACK controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNavigate to the \u003cstrong\u003eCatalog -\u0026gt; OperatorHub\u003c/strong\u003e page in the OpenShift web console and then search for the ACK service controller operator you wish to install. Click \u003cstrong\u003eInstall\u003c/strong\u003e and ensure you use the \u003cstrong\u003eAll Namespaces\u003c/strong\u003e install mode, if prompted.\u003c/p\u003e\n\u003cp\u003eFor more information, see the official documentation for \u003ca href="https://docs.openshift.com/container-platform/4.9/operators/user/olm-installing-operators-in-namespace.html"\u003einstalling Operators into an OpenShift cluster\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Since authentication setup is required before installing an ACK operator into OpenShift as explained in the OpenShift pre-installation steps, you do not need to set up authentication after installation as suggested below in \u0026ldquo;Next steps.\u0026rdquo;\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eOnce you have installed your ACK service controllers, you can\n\u003ca href="../irsa/"\u003ecreate an IAM role to provide AWS access\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eAnd learn the different ways that\n\u003ca href="../authentication/"\u003eAWS credentials can be supplied\u003c/a\u003e to the ACK controller.\u003c/p\u003e\n'}).add({id:3,href:"https://aws-controllers-k8s.github.io/community/docs/community/overview/",title:"Overview",description:"AWS Controllers for Kubernetes (ACK) lets you define and use AWS service resources directly from Kubernetes",content:'\u003cp\u003e\u003cstrong\u003eAWS Controllers for Kubernetes (ACK)\u003c/strong\u003e lets you define and use AWS service resources directly from Kubernetes. With ACK, you can take advantage of AWS-managed services for your Kubernetes applications without needing to define resources outside of the cluster or run services that provide supporting capabilities like databases or message queues within the cluster.\u003c/p\u003e\n\u003ch2 id="container-images"\u003eContainer images\u003c/h2\u003e\n\u003cp\u003eEach ACK service controller is packaged into a separate container image that is published in a public repository corresponding to an individual ACK service controller.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Choose the ACK container image that is right for you\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Note that there is no single ACK container image. Instead, there are container\nimages for each individual ACK service controller that manages resources\nfor a particular AWS API.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eContainer images for ACK service controllers can be found in the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s"\u003eACK registry within the Amazon ECR Public Gallery\u003c/a\u003e. To find a container image for a specific service, you can go to \u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/$SERVICENAME-controller\u003c/code\u003e. For example, the link to the ACK service controller container image for Amazon Simple Storage Service (Amazon S3) is \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-controller"\u003e\u003ccode\u003egallery.ecr.aws/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIndividual ACK service controllers are tagged with their release version. You can find image URIs for different releases under the \u003ccode\u003eImage tags\u003c/code\u003e section in the image repository on the ECR Public Gallery.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Be sure to specify a release version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n You must always specify a version tag when referencing an ACK service controller image.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn accordance with \u003ca href="https://vsupalov.com/docker-latest-tag/"\u003ebest practices\u003c/a\u003e, we do not include \u003ccode\u003e:latest\u003c/code\u003e default tags for our image repositories.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThis guide assumes that you have access to a Kubernetes cluster. You do not need to use the Amazon Elastic Kubernetes Service (Amazon EKS) to get started with ACK service controllers. If you do not yet have a Kubernetes cluster and would like to use Amazon EKS, you can visit the \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e guide.\u003c/p\u003e\n\u003cp\u003eOnce you have access to a Kubernetes cluster, you can \u003ca href="../../user-docs/install/"\u003einstall the ACK service controller of your choice\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:4,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/tenets/",title:"Project Tenets",description:"Our project tenets and design principles",content:'\u003cp\u003eWe follow a set of tenets in building AWS Controllers for Kubernetes.\u003c/p\u003e\n\u003ch2 id="collaborate-in-the-open"\u003eCollaborate in the Open\u003c/h2\u003e\n\u003cp\u003eWhen given a choice between keeping something hidden or making something open,\nwe default to open.\u003c/p\u003e\n\u003cp\u003eAll of our \u003ca href="https://github.com/aws-controllers-k8s/"\u003esource code\u003c/a\u003e is open.\u003c/p\u003e\n\u003cp\u003eOur development methodology is open.\u003c/p\u003e\n\u003cp\u003eOur \u003ca href="https://github.com/aws-controllers-k8s/test-infra"\u003etesting\u003c/a\u003e, \u003ca href="../../community/releases/"\u003erelease\u003c/a\u003e and \u003ca href="https://github.com/aws-controllers-k8s/community/tree/main/docs"\u003edocumentation\u003c/a\u003e processes\nare open.\u003c/p\u003e\n\u003cp\u003eOur \u003ca href="https://prow.ack.aws.dev/"\u003econtinuous integration system\u003c/a\u003e is open.\u003c/p\u003e\n\u003cp\u003eWe are a community-driven project that strives to meet our users where they\nare. Come join our \u003ca href="https://github.com/aws-controllers-k8s/community/#community-meeting"\u003ecommunity meeting\u003c/a\u003e on Zoom.\u003c/p\u003e\n\u003ch2 id="generate-everything"\u003eGenerate Everything\u003c/h2\u003e\n\u003cp\u003eWe choose to generate as much of our code as possible.\u003c/p\u003e\n\u003cp\u003eWhile we recognize that the differences and peculiarities of AWS service APIs\nwill naturally require some implementation code to be hand-written, we look for\npatterns in AWS service APIs and enhance our code generator to handle these\npatterns.\u003c/p\u003e\n\u003cp\u003eGenerated code is easier to maintain and encourages consistency.\u003c/p\u003e\n\u003ch2 id="focus-on-kubernetes"\u003eFocus on Kubernetes\u003c/h2\u003e\n\u003cp\u003eThe ACK code generator produces controller implementations that include a\n\u003ca href="https://github.com/aws-controllers-k8s/runtime"\u003ecommon ACK runtime\u003c/a\u003e. This common runtime builds on top of the Kubernetes\nupstream \u003ca href="https://github.com/kubernetes-sigs/controller-runtime/"\u003econtroller-runtime\u003c/a\u003e framework and provides a common\nreconciliation loop that processes events received from the Kubernetes API\nserver representing create, modify or delete operations for a custom resource.\nBy building ACK controllers with a common ACK runtime, we encourage consistent\nbehaviour in how controllers handle these custom resources.\u003c/p\u003e\n\u003cp\u003eWe seek ways to make the \u003cstrong\u003eKubernetes user experience\u003c/strong\u003e as simple and\nconsistent as possible for managing AWS resources. This means that the ACK code\ngenerator enables service teams to rename fields for a resource, inject custom\ncode into a controller and instruct the controller implementation to handle\nresources in ways that smooth over the inconsistencies between AWS service\nAPIs.\u003c/p\u003e\n\u003ch2 id="run-anywhere"\u003eRun Anywhere\u003c/h2\u003e\n\u003cp\u003eACK service controllers can be installed on any Kubernetes cluster, regardless\nof whether a user chooses to use Amazon Elastic Kubernetes Service (EKS).\u003c/p\u003e\n\u003ch2 id="minimize-service-dependencies"\u003eMinimize Service Dependencies\u003c/h2\u003e\n\u003cp\u003eThe only AWS services that ACK service controllers depend on should be IAM/STS\nand the specific AWS service that the controller integrates with.\u003c/p\u003e\n\u003cp\u003eWe do not take a dependency on any stateful resource-tracking service,\nincluding AWS CloudFormation, the AWS Cloud Control API, or Terraform.\u003c/p\u003e\n\u003cp\u003eACK service controllers communicate directly with the AWS service API that the\ncontroller is built for. The \u003ccode\u003es3-controller\u003c/code\u003e speaks the S3 API. The\n\u003ccode\u003eec2-controller\u003c/code\u003e speaks the EC2 API.\u003c/p\u003e\n'}).add({id:5,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generation/",title:"Code Generation",description:"How to generate ACK controllers",content:'\u003cp\u003eIn order to keep the code for all the service controllers consistent, we will\nuse a strategy of generating the custom resource definitions and controller\ncode stubs for new AWS services.\u003c/p\u003e\n\u003ch2 id="options-considered"\u003eOptions considered\u003c/h2\u003e\n\u003cp\u003eTo generate custom resource (definitions) and controller stub code, we\ninvestigated a number of options:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ehome-grown custom code generator\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kudo.dev"\u003ekudo\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/kubernetes-sigs/kubebuilder"\u003ekubebuilder\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003ea hybrid custom code generator + \u003ccode\u003esigs.kubernetes.io/controller-tools\u003c/code\u003e (CR)\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe original AWS Service Operator used a \u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/code-generation"\u003ecustom-built generator\u003c/a\u003e that\nprocessed \u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/models"\u003eYAML manifests\u003c/a\u003e describing the AWS service and used\n\u003ca href="https://github.com/amazon-archives/aws-service-operator/tree/master/code-generation/pkg/codegen/assets"\u003etemplates\u003c/a\u003e to \u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/b4befd62322a57ac78aa39ea08771fc32912592a/code-generation/pkg/codegen/assets/aws-service-operator.yaml.templ#L13-L31"\u003egenerate CRDs\u003c/a\u003e, the \u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/master/code-generation/pkg/codegen/assets/operator.go.templ"\u003econtroller code\u003c/a\u003e itself and the\n\u003ca href="https://github.com/amazon-archives/aws-service-operator/blob/master/code-generation/pkg/codegen/assets/types.go.templ"\u003eGo types\u003c/a\u003e that represent the CRDs in memory. It\u0026rsquo;s worth noting that the\nCRDs \u003cem\u003eand\u003c/em\u003e the controller code that was generated by the original ASO was very\ntightly coupled to CloudFormation. In fact, the CRDs for individual AWS\nservices like S3 or RDS were thin wrappers around CloudFormation stacks that\ndescribed the object being operated upon.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003ekudo\u003c/code\u003e is a platform for building Kubernetes Operators. It stores state in its\nown kudo.dev CRDs and allows users to define \u0026ldquo;plans\u0026rdquo; for a deployed application\nto deploy itself. We determined that kudo was not a particularly good fit for\nASO for a couple reasons. First, we needed a way to generate CRDs in several\nAPI groups (s3.aws.com and iam.aws.com for example) and the ACK controller code\nisn\u0026rsquo;t deploying an \u0026ldquo;application\u0026rdquo; that needs to have a controlled deployment\nplan. Instead, ACK is a collection of controllers that facilitates creation and\nmanagement of various AWS service objects using Kubernetes CRD instances.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003ekubebuilder\u003c/code\u003e is the recommended upstream tool for generating CRDs and controller\nstub code. It is a Go binary that creates the scaffolding for CRDs and\ncontroller Go code. It has support for multiple API groups (e.g. \u003ccode\u003es3.amazonaws.com\u003c/code\u003e\nand \u003ccode\u003edynamodb.amazonaws.com\u003c/code\u003e) in a single code repository, so allows for sensible\nseparation of code.\u003c/p\u003e\n\u003cp\u003eOur final option was to build a hybrid custom code generator that used\ncontroller-runtime under the hood but allowed us to generate controller stub\ncode for multiple API groups and place generated code \u003ca href="https://github.com/kubernetes-sigs/kubebuilder/issues/1268"\u003ein directories\u003c/a\u003e that\nrepresented Go best practices. This option gives us the flexibility to generate\nthe files and content for multiple API groups but still stay within the\nrecommended guardrails of the upstream Kubernetes community.\u003c/p\u003e\n\u003ch2 id="our-approach"\u003eOur approach\u003c/h2\u003e\n\u003cp\u003eWe ended up with a hybrid custom+controller-runtime, using multiple phases of\ncode generation:\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/multi-phase-code-generation.png" alt="Multi-phase approach to code generation for ACK"\u003e\u003c/p\u003e\n\u003cp\u003eThe first code generation phase consumes model information from a canonical\nsource of truth about an AWS service and the objects and interfaces that\nservice exposes and generates files containing code that exposes Go types for\nthose objects. These \u0026ldquo;type files\u0026rdquo; should be annotated with the marker and\ncomments that will allow the core code generators and controller-gen to do its\nwork. We will use the \u003ca href="https://github.com/aws/aws-sdk-go/tree/master/models/apis"\u003emodel\nfiles\u003c/a\u003e from the\n\u003ca href="https://github.com/aws/aws-sdk-go"\u003e\u003ccode\u003eaws-sdk-go\u003c/code\u003e\u003c/a\u003e source repository as our\nsource of truth and use the \u003ccode\u003eaws-sdk-go/private/model/api\u003c/code\u003e Go package to\nnavigate that model.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step is the \u003ccode\u003eack-generate apis\u003c/code\u003e command.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAfter generating Kubernetes API type definitions for the top-level resources\nexposed by the AWS API, we then need to generate the \u0026ldquo;DeepCopy\u0026rdquo; interface\nimplementations that enable those top-level resources and type definitions to\nbe used by the Kubernetes runtime package (it defines an interface called\n\u003ccode\u003eruntime.Object\u003c/code\u003e that requires certain methods that copy the object and its\ncomponent parts).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen object\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, we generate the custom resource definition (CRD) configuration files, one\nfor each top-level resource identified in earlier steps.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen crd\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, we generate the actual implementation of the ACK controller for the\ntarget service. This step uses a set of templates and code in the \u003ccode\u003epkg/model\u003c/code\u003e\nGo package to construct the service-specific resource management and linkage\nwith the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client for the service. Along with these controller\nimplementation Go files, this step also outputs a set of Kubernetes\nconfiguration files for the \u003ccode\u003eDeployment\u003c/code\u003e and the \u003ccode\u003eClusterRoleBinding\u003c/code\u003e of the\n\u003ccode\u003eRole\u003c/code\u003e created in the next step.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003eack-generate controller\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eFinally, we generate the configuration file for a Kubernetes \u003ccode\u003eRole\u003c/code\u003e that the\nKubernetes \u003ccode\u003ePod\u003c/code\u003e (running in a Kubernetes \u003ccode\u003eDeployment\u003c/code\u003e) running the ACK service\ncontroller. This \u003ccode\u003eRole\u003c/code\u003e needs to have permissions to read and write CRs of the\nKind that the service controller manages.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n This step runs the \u003ccode\u003econtroller-gen rbac\u003c/code\u003e command\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="crossplane-provider-generation"\u003eCrossplane Provider Generation\u003c/h3\u003e\n\u003cp\u003eWe have experimental support for generating API types and controller code for AWS\nservices to be used in Crossplane AWS Provider. To try it out, you can run the\nfollowing command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ego run -tags codegen cmd/ack-generate/main.go crossplane ecr --provider-dir \u0026lt;directory for provider\u0026gt;\ncd \u0026lt;directory for provider\u0026gt;\ngo generate ./...\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:6,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-organization/",title:"Code Organization",description:"How the source code for ACK is organized",content:'\u003cp\u003eACK is a collection of source repositories containing a common runtime and type\nsystem, a code generator and individual service controllers that manage\nresources in a specific AWS API.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/community/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e\u003c/a\u003e: docs, issues and\nproject management (this repo)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/runtime/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/a\u003e: common ACK runtime and types\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/code-generator/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/a\u003e: the code generator and\ntemplates\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws-controllers-k8s/test-infra/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/a\u003e: common test code and infrastructure\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/$SERVICE-controller\u003c/code\u003e: individual ACK\ncontrollers for AWS services.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="githubcomaws-controllers-k8scommunity-this-repo"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e (this repo)\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/community/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/community\u003c/code\u003e\u003c/a\u003e source code\nrepository (this repo) contains the documentation that gets published to\nhttps://aws-controllers-k8s.github.io/community/.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Bug reports and feature requests\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eNOTE\u003c/strong\u003e: All [bug reports and feature requests][issues] for all ACK source repositories\nare contained in this repository.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="githubcomaws-controllers-k8sruntime"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/runtime/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e\u003c/a\u003e source code repository contains\nthe common ACK controller runtime (\u003ccode\u003e/pkg/runtime\u003c/code\u003e, \u003ccode\u003e/pkg/types\u003c/code\u003e) and core\npublic Kubernetes API types (\u003ccode\u003e/apis/core\u003c/code\u003e).\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8scode-generator"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/code-generator/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\u003c/a\u003e source code repository\ncontains the \u003ccode\u003eack-generate\u003c/code\u003e CLI tool (\u003ccode\u003e/cmd/ack-generate\u003c/code\u003e), the Go packages\nthat are used in API inference and code generation (\u003ccode\u003e/pkg/generate\u003c/code\u003e,\n\u003ccode\u003e/pkg/model\u003c/code\u003e) and Bash scripts to build an ACK service controller\n(\u003ccode\u003e/scripts/build-controller.sh\u003c/code\u003e).\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8stest-infra"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://github.com/aws-controllers-k8s/test-infra/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e\u003c/a\u003e source code repository\ncontains the \u003ccode\u003eacktest\u003c/code\u003e Python package for common ACK e2e test code, the CDK to\ndeploy our Prow CI/CD system and the scripts for running tests locally.\u003c/p\u003e\n\u003ch2 id="githubcomaws-controllers-k8sservice-controller"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/$SERVICE-controller\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eEach AWS API that has had a Kubernetes controller built to manage resources in\nthat API has its own source code repository in the\n\u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github Organization. The source repos will be\ncalled \u003ccode\u003e$SERVICE-controller\u003c/code\u003e, for example the ACK service controller for S3 is\nlocated at \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/"\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eThese service controller repositories contain Go code for the main controller\nbinary (\u003ccode\u003e/cmd/controller/\u003c/code\u003e), the public API types for the controllers\n(\u003ccode\u003e/apis\u003c/code\u003e), the Go code for the resource managers used by the controller\n(\u003ccode\u003e/pkg/resource/*/\u003c/code\u003e), static configuration manifests (\u003ccode\u003e/config\u003c/code\u003e), Helm\ncharts for the controller installation (\u003ccode\u003e/helm\u003c/code\u003e) along with a set of end-to-end\ntests for the resources exposed by that controller (\u003ccode\u003e/test/e2e\u003c/code\u003e).\u003c/p\u003e\n'}).add({id:7,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/",title:"Configure IAM Permissions",description:"Setting up ACK with IAM Roles for Service Accounts",content:'\u003cp\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Accounts\u003c/a\u003e, or IRSA, is a system that automates the\nprovisioning and rotation of IAM temporary credentials (called a Web Identity)\nthat a Kubernetes \u003ccode\u003eServiceAccount\u003c/code\u003e can use to call AWS APIs.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n TL;DR:\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eInstead of creating and distributing your AWS credentials to the containers or\nusing the Amazon EC2 instance’s role, you can associate an IAM role with a Kubernetes\nservice account. The applications in a Kubernetes pod container can then use an\nAWS SDK or the AWS CLI to make API requests to authorized AWS services.\u003c/p\u003e\n\u003cp\u003eQuicklinks:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="./#step-1-create-an-oidc-identity-provider-for-your-cluster"\u003eSetup IRSA for EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook/blob/master/SELF_HOSTED_SETUP.md"\u003eSetup IRSA for non-EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFollow the quicklink OR continue reading for more details about IRSA.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe primary advantage of IRSA is that Kubernetes \u003ccode\u003ePods\u003c/code\u003e which use the\n\u003ccode\u003eServiceAccount\u003c/code\u003e associated with an IAM Role can have a reduced IAM permission\nfootprint than the IAM Role in use for the Kubernetes EC2 worker node (known as\nthe EC2 Instance Profile Role). This security concept is known as \u003cstrong\u003eLeast\nPrivilege\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eFor example, assume you have a broadly-scoped IAM Role with permissions to\naccess the Instance Metadata Service (IMDS) from the EC2 worker node. If you do\nnot want Kubernetes \u003ccode\u003ePods\u003c/code\u003e running on that EC2 Instance to have access to IMDS,\nyou can create a different IAM Role with a reduced permission set and associate\nthis reduced-scope IAM Role with the Kubernetes \u003ccode\u003eServiceAccount\u003c/code\u003e the \u003ccode\u003ePod\u003c/code\u003e\nuses. IRSA will ensure that a special file is injected (and rotated\nperiodically) into the \u003ccode\u003ePod\u003c/code\u003e that contains a JSON Web Token (JWT) that\nencapsulates a request for temporary credentials to assume the IAM Role with\nreduced permissions.\u003c/p\u003e\n\u003cp\u003eWhen AWS clients or SDKs connect to an AWS API, they detect the existence of\nthis special token file and call the \u003ca href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html"\u003e\u003ccode\u003eSTS::AssumeRoleWithWebIdentity\u003c/code\u003e\u003c/a\u003e API\nto assume the IAM Role with reduced permissions.\u003c/p\u003e\n\u003cp\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Accounts\u003c/a\u003e (IRSA) automates the provisioning and rotation of AWS Identity and Access Management (IAM) temporary credentials that a Kubernetes service account can use to call AWS APIs.\u003c/p\u003e\n\u003cp\u003eInstead of creating and distributing your AWS credentials to the containers or using the Amazon EC2 instance’s role, you can associate an IAM role with a Kubernetes service account. The applications in a Kubernetes pod container can then use an AWS SDK or the AWS CLI to make API requests to authorized AWS services.\u003c/p\u003e\n\u003cp\u003eBy using the IRSA feature, you no longer need to provide extended permissions to the node IAM role so that pods on that node can call AWS APIs. You can scope IAM permissions to a service account, and only pods that use that service account have access to those permissions.\u003c/p\u003e\n\u003cp\u003eThe following steps demonstrate how to set up IRSA on an EKS cluster while installing the ACK S3 controller using Helm charts. By modifying the variable values as needed, these steps can be applied for the installation of other ACK service controllers.\u003c/p\u003e\n\u003ch2 id="step-1-create-an-oidc-identity-provider-for-your-cluster"\u003eStep 1. Create an OIDC identity provider for your cluster\u003c/h2\u003e\n\u003cp\u003eCreate an \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html"\u003eOpenID Connect (OIDC) identity provider\u003c/a\u003e for your EKS cluster using the \u003ccode\u003eeksctl utils\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport EKS_CLUSTER_NAME=\u0026lt;eks cluster name\u0026gt;\nexport AWS_REGION=\u0026lt;aws region id\u0026gt;\neksctl utils associate-iam-oidc-provider --cluster $EKS_CLUSTER_NAME --region $AWS_REGION --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor detailed instructions, refer to Amazon EKS documentation on how to \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html"\u003ecreate an IAM OIDC provider for your cluster\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="step-2-create-an-iam-role-and-policy-for-your-service-account"\u003eStep 2. Create an IAM role and policy for your service account\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eIf you\u0026rsquo;re trying to set up IRSA on OpenShift replace the \u003ccode\u003eOIDC_PROVIDER\u003c/code\u003e line in the bash script below with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eOIDC_PROVIDER=$(oc get authentication cluster -ojson | jq -r .spec.serviceAccountIssuer | sed -e \u0026quot;s/^https:\\/\\///\u0026quot;)\n\u003c/code\u003e\u003c/pre\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="create-an-iam-role-for-your-ack-service-controller"\u003eCreate an IAM role for your ACK service controller\u003c/h3\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the service name variables as needed\nSERVICE=\u0026quot;s3\u0026quot;\nAWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nOIDC_PROVIDER=$(aws eks describe-cluster --name $EKS_CLUSTER_NAME --region $AWS_REGION --query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | sed -e \u0026quot;s/^https:\\/\\///\u0026quot;)\nACK_K8S_NAMESPACE=ack-system\n\nACK_K8S_SERVICE_ACCOUNT_NAME=ack-$SERVICE-controller\n\nread -r -d \'\' TRUST_RELATIONSHIP \u0026lt;\u0026lt;EOF\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:oidc-provider/${OIDC_PROVIDER}\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;${OIDC_PROVIDER}:sub\u0026quot;: \u0026quot;system:serviceaccount:${ACK_K8S_NAMESPACE}:${ACK_K8S_SERVICE_ACCOUNT_NAME}\u0026quot;\n }\n }\n }\n ]\n}\nEOF\necho \u0026quot;${TRUST_RELATIONSHIP}\u0026quot; \u0026gt; trust.json\n\nACK_CONTROLLER_IAM_ROLE=\u0026quot;ack-${SERVICE}-controller\u0026quot;\nACK_CONTROLLER_IAM_ROLE_DESCRIPTION=\u0026quot;IRSA role for ACK ${SERVICE} controller deployment on EKS cluster using Helm charts\u0026quot;\naws iam create-role --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; --assume-role-policy-document file://trust.json --description \u0026quot;${ACK_CONTROLLER_IAM_ROLE_DESCRIPTION}\u0026quot;\nACK_CONTROLLER_IAM_ROLE_ARN=$(aws iam get-role --role-name=$ACK_CONTROLLER_IAM_ROLE --query Role.Arn --output text)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="attach-iam-policy-to-the-iam-role"\u003eAttach IAM policy to the IAM role\u003c/h3\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The command below will attach the ACK recommended policy to the IAM role. If you\nwish to use any other permissions, change \u003ccode\u003eIAM_POLICY_ARN\u003c/code\u003e variable\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Download the recommended managed and inline policies and apply them to the\n# newly created IRSA role\nBASE_URL=https://raw.githubusercontent.com/aws-controllers-k8s/${SERVICE}-controller/main\nPOLICY_ARN_URL=${BASE_URL}/config/iam/recommended-policy-arn\nPOLICY_ARN_STRINGS=\u0026quot;$(wget -qO- ${POLICY_ARN_URL})\u0026quot;\n\nINLINE_POLICY_URL=${BASE_URL}/config/iam/recommended-inline-policy\nINLINE_POLICY=\u0026quot;$(wget -qO- ${INLINE_POLICY_URL})\u0026quot;\n\nwhile IFS= read -r POLICY_ARN; do\n echo -n \u0026quot;Attaching $POLICY_ARN ... \u0026quot;\n aws iam attach-role-policy \\\n --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; \\\n --policy-arn \u0026quot;${POLICY_ARN}\u0026quot;\n echo \u0026quot;ok.\u0026quot;\ndone \u0026lt;\u0026lt;\u0026lt; \u0026quot;$POLICY_ARN_STRINGS\u0026quot;\n\nif [ ! -z \u0026quot;$INLINE_POLICY\u0026quot; ]; then\n echo -n \u0026quot;Putting inline policy ... \u0026quot;\n aws iam put-role-policy \\\n --role-name \u0026quot;${ACK_CONTROLLER_IAM_ROLE}\u0026quot; \\\n --policy-name \u0026quot;ack-recommended-policy\u0026quot; \\\n --policy-document \u0026quot;$INLINE_POLICY\u0026quot;\n echo \u0026quot;ok.\u0026quot;\nfi\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor detailed instructions, refer to Amazon EKS documentation on \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/create-service-account-iam-policy-and-role.html"\u003ecreating an IAM role and policy for your service account\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="step-3-associate-an-iam-role-to-a-service-account-and-restart-deployment"\u003eStep 3. Associate an IAM role to a service account and restart deployment\u003c/h2\u003e\n\u003cp\u003eIf you \u003ca href="../install/"\u003einstalled your ACK service controller using a Helm chart\u003c/a\u003e, then a service account already exists on your cluster. However, it is still neccessary to associate an IAM role with the service account.\u003c/p\u003e\n\u003cp\u003eVerify that your service account exists using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe serviceaccount/$ACK_K8S_SERVICE_ACCOUNT_NAME -n $ACK_K8S_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote that the Amazon Resource Name (ARN) of the IAM role that you created is not yet set as an annotation for the service account.\u003c/p\u003e\n\u003cp\u003eUse the following commands to associate an IAM role to a service account:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Annotate the service account with the ARN\nexport IRSA_ROLE_ARN=eks.amazonaws.com/role-arn=$ACK_CONTROLLER_IAM_ROLE_ARN\nkubectl annotate serviceaccount -n $ACK_K8S_NAMESPACE $ACK_K8S_SERVICE_ACCOUNT_NAME $IRSA_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRestart ACK service controller deployment using the following commands. The restart\nwill update service controller pods with IRSA environment variables\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Note the deployment name for ACK service controller from following command\nkubectl get deployments -n $ACK_K8S_NAMESPACE\nkubectl -n $ACK_K8S_NAMESPACE rollout restart deployment \u0026lt;ACK deployment name\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-4-verify-successful-setup"\u003eStep 4: Verify successful setup\u003c/h2\u003e\n\u003cp\u003eWhen AWS clients or SDKs connect to an AWS API, they detect an \u003ca href="https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRoleWithWebIdentity.html"\u003eAssumeRoleWithWebIdentity\u003c/a\u003e security token to assume the IAM role.\u003c/p\u003e\n\u003cp\u003eVerify that the \u003ccode\u003eAWS_WEB_IDENTITY_TOKEN_FILE\u003c/code\u003e and \u003ccode\u003eAWS_ROLE_ARN\u003c/code\u003e environment variables exist for your Kubernetes pod using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get pods -n $ACK_K8S_NAMESPACE\nkubectl describe pod -n $ACK_K8S_NAMESPACE \u0026lt;NAME\u0026gt; | grep \u0026quot;^\\s*AWS_\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output should contain following two lines:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ROLE_ARN=arn:aws:iam::\u0026lt;AWS_ACCOUNT_ID\u0026gt;:role/\u0026lt;IAM_ROLE_NAME\u0026gt;\nAWS_WEB_IDENTITY_TOKEN_FILE=/var/run/secrets/eks.amazonaws.com/serviceaccount/token\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that ACK service controller is setup successfully with AWS permissions, let\u0026rsquo;s\nvalidate by \u003ca href="../resource-crud"\u003ecreating a S3 bucket\u003c/a\u003e\u003c/p\u003e\n'}).add({id:8,href:"https://aws-controllers-k8s.github.io/community/docs/community/faq/",title:"FAQ",description:"Frequently asked questions",content:'\u003ch2 id="service-broker"\u003eService Broker\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Does ACK replace the \u003ca href="https://svc-cat.io/"\u003eservice broker\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eFor the time being, people using the service broker should continue to use it and we\u0026rsquo;re coordinating with the maintainers to provide a unified solution.\u003c/p\u003e\n\u003cp\u003eThe service broker project is also an AWS activity that, with the general shift of focus in the community from service broker to operators, can be considered less actively developed. There are a certain things around application lifecycle management that the service broker currently covers and which are at this juncture not yet covered by the scope of ACK, however we expect in the mid to long run that these two projects converge. We had AWS-internal discussions with the team that maintains the service broker and we\u0026rsquo;re on the same page concerning a unified solution.\u003c/p\u003e\n\u003cp\u003eWe appreciate input and advice concerning features that are currently covered by the service broker only, for example bind/unbind or cataloging and looking forward to learn from the community how they are using service broker so that we can take this into account.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="cluster-api"\u003eCluster API\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Does the planned ACK service controller for EKS replace \u003ca href="https://github.com/kubernetes-sigs/cluster-api"\u003eKubernetes Cluster API\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNo, the ACK service controller for EKS does not replace Kubernetes Cluster API.\nCluster API does a lot of really cool things and is designed to be a generic way to create Kubernetes clusters that run anywhere.\nIt makes some different design decisions with that goal in mind.\nSome differences include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCluster API is treated as your source of truth for all infrastructure.\nThis means things like the cluster autoscaler need to be configured to use cluster api instead of AWS cloud provider.\u003c/li\u003e\n\u003cli\u003eGeneric Kubernetes clusters rely on running more services in the cluster and not services from AWS.\nThings like metrics and logging will likely need to run inside Kubernetes instead of using services like CloudWatch.\u003c/li\u003e\n\u003cli\u003eIAM permission for Cluster-API Provider AWS (CAPA) need to be more broad than the ACK service controller for EKS because CAPA is responsible for provisioning everything needed for the cluster (VPC, gateway, etc).\nYou don\u0026rsquo;t need to run all of the ACK controllers if all you want is a way to provision an EKS cluster.\nYou can pick and choose which ACK controllers you want to deploy.\u003c/li\u003e\n\u003cli\u003eWith the EKS ACK controller you will get all of the configuration flexibility of the EKS API including things like managed node groups and fargate.\nThis is because the ACK service controller for EKS is built directly from the EKS API spec and not abstracted to be a general Kubernetes cluster.\u003c/li\u003e\n\u003c/ul\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="cdk8s"\u003ecdk8s\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n How does ACK relate to \u003ca href="https://cdk8s.io/"\u003ecdk8s\u003c/a\u003e?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003ecdk8s is an open-source software development framework for defining Kubernetes applications and reusable abstractions using familiar programming languages and rich object-oriented APIs.\nYou can use cdk8s to create any resource inside a Kubernetes cluster.\nThis includes \u003ca href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/"\u003eCustom Resources\u003c/a\u003e (CRs).\u003c/p\u003e\n\u003cp\u003eAll of the ACK controllers watch for specific CRs and you can generate those resources using cdk8s or any Kubernetes tooling.\nThe two projects complement each other.\ncdk8s can create the Kubernetes resources and ACK uses those resources to create the AWS infrastructure.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="troubleshooting"\u003eTroubleshooting\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Why are my AWS resources sometimes not being fully deleted when trying to delete via \u003ccode\u003ekubectl delete ... --cascade=foreground ...\u003c/code\u003e (or via ArgoCD uninstalling my Helm chart)?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThere is a \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1759"\u003eknown issue with foreground cascading deletion\u003c/a\u003e in the ACK runtime that potentially impacts all controllers.\u003c/p\u003e\n\u003cp\u003eUntil the above issue is resolved, you should use \u003ca href="https://kubernetes.io/docs/tasks/administer-cluster/use-cascading-deletion/#use-background-cascading-deletion"\u003ebackground cascading deletion\u003c/a\u003e (the default behavior of \u003ccode\u003ekubectl\u003c/code\u003e) to delete resources.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Why am I seeing \u003ccode\u003eError: manifest does not contain minimum number of descriptors (2), descriptors found: 1\u003c/code\u003e when trying to install the Helm chart?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003ca href="https://github.com/helm/helm/releases/tag/v3.7.0"\u003eHelm 3.7\u003c/a\u003e included backward compatibility breaking changes to the manifest format of Helm charts stored in OCI chart repositories. Any images built using Helm \u0026lt;3.7 are not compatible with the latest version of the Helm CLI. This can be solved by using latest version of the chart. Use Helm version 3.7 or above with the latest version of the charts.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="contributing"\u003eContributing\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Question\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Where and how can I help?\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-answer"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Answer\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Excellent question and we\u0026rsquo;re super excited that you\u0026rsquo;re interested in ACK.\nFor now, if you\u0026rsquo;re a developer, you can check out the \u003ca href="../../contributor-docs/overview/"\u003econtributor docs\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n'}).add({id:9,href:"https://aws-controllers-k8s.github.io/community/docs/community/how-it-works/",title:"How it Works",description:"How the ACK controller works",content:'\u003cp\u003eThe idea behind AWS Controllers for Kubernetes (ACK) is to enable Kubernetes\nusers to describe the desired state of AWS resources using the Kubernetes API\nand configuration language. In order to make this happen, let\u0026rsquo;s take a look\nunder the covers and walk through how different components in the system\ninteract.\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/ack-how-it-works.png" alt="event flow in ACK"\u003e\u003c/p\u003e\n\u003cp\u003eIn the diagram above, Alice is our Kubernetes user. Her application depends on\nthe existence of an Amazon S3 Bucket named \u003ccode\u003emy-bucket\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eInstead of creating the S3 Bucket via the AWS web console, Alice wants to only\nuse the Kubernetes API. After all, Alice uses the Kubernetes API to describe\nall her application resources \u0026ndash; a \u003ccode\u003eDeployment\u003c/code\u003e, a \u003ccode\u003eService\u003c/code\u003e, an \u003ccode\u003eIngress\u003c/code\u003e,\netc. She\u0026rsquo;d like to use the Kubernetes API to describe all the resources her\napplication requires, including this S3 Bucket.\u003c/p\u003e\n\u003cp\u003eSo, Alice issues a call to \u003ccode\u003ekubectl apply\u003c/code\u003e, passing in a file that describes a\nKubernetes \u003ca href="https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/"\u003ecustom resource\u003c/a\u003e describing her S3 Bucket. \u003ccode\u003ekubectl apply\u003c/code\u003e\npasses this file, called a \u003ca href="https://kubernetes.io/docs/reference/glossary/?all=true#term-manifest"\u003e\u003ccode\u003eManifest\u003c/code\u003e\u003c/a\u003e, to the Kubernetes API server\nrunning in the Kubernetes controller node. \u003ccode\u003e(1)\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eThe Kubernetes API server receives the \u003ccode\u003eManifest\u003c/code\u003e describing the S3 Bucket and\ndetermines if Alice \u003ca href="../../user-docs/authorization/"\u003ehas permissions\u003c/a\u003e to create a custom resource (CR)\nof \u003ca href="https://kubernetes.io/docs/reference/using-api/api-concepts/#standard-api-terminology"\u003e\u003ccode\u003eKind\u003c/code\u003e\u003c/a\u003e \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e, and that the custom\nresource is properly formatted \u003ccode\u003e(2)\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eIf Alice is authorized and the CR is valid, the Kubernetes API server writes\n\u003ccode\u003e(3)\u003c/code\u003e the CR to its \u003ccode\u003eetcd\u003c/code\u003e data store and then responds back \u003ccode\u003e(4)\u003c/code\u003e to Alice\nthat the CR has been created.\u003c/p\u003e\n\u003cp\u003eAt this point, the ACK service \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-controller"\u003econtroller\u003c/a\u003e for S3, which is\nrunning on a Kubernetes worker node within the context of a normal Kubernetes\n\u003ca href="https://kubernetes.io/docs/concepts/workloads/pods/"\u003e\u003ccode\u003ePod\u003c/code\u003e\u003c/a\u003e, is notified \u003ccode\u003e(5)\u003c/code\u003e that a new CR of \u003ccode\u003eKind\u003c/code\u003e\n\u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e has been created.\u003c/p\u003e\n\u003cp\u003eThe ACK service controller for S3 then communicates \u003ccode\u003e(6)\u003c/code\u003e with the AWS S3 API,\ncalling the \u003ca href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html"\u003eS3 \u003ccode\u003eCreateBucket\u003c/code\u003e API call\u003c/a\u003e to create the bucket in\nAWS. After communicating with the S3 API, the ACK service controller then calls\nthe Kubernetes API server to update \u003ccode\u003e(7)\u003c/code\u003e the CR\u0026rsquo;s \u003ca href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/#object-spec-and-status"\u003e\u003ccode\u003eStatus\u003c/code\u003e\u003c/a\u003e with\ninformation it received from S3.\u003c/p\u003e\n\u003ch2 id="drift-detection-and-remediation"\u003eDrift Detection and Remediation\u003c/h2\u003e\n\u003cp\u003eThere are times where a resource that an ACK service controller is managing is\nmodified outside of ACK, e.g. through the AWS CLI or the console. An ACK service\ncontroller will look for any drift and attempt to remediate every 10 hours\n(unless a different frequency is configured). As part of the remediation, an ACK\nservice controller will reconfigure the managed resource based on the \u003ccode\u003eSpec\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eFor more information about configuring the drift remediation period, see\n\u003ca href="../../user-docs/drift-recovery"\u003eRecovering from Drift\u003c/a\u003e\u003c/p\u003e\n'}).add({id:10,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/operatorhub-onboarding/",title:"OperatorHub Onboarding",description:"How controllers end up in OperatorHub",content:'\u003cp\u003eThere are two ways a user can install an operator, one is via an OLM enabled cluster using OperatorHub.io and the other\nis via the embedded OperatorHub within an OpenShift cluster. In order to onboard a new controller and have it appear in both\nplaces, the below steps should be followed. After these steps are completed, the build/release process will then raise pull\nrequests against the proper repos.\u003c/p\u003e\n\u003ch2 id="add-an-olm-config-file-to-controller-repository"\u003eAdd an OLM Config File to Controller Repository\u003c/h2\u003e\n\u003cp\u003eThe OLM config file is used during the build/release process of a controller to assist in the generation of the\n\u003ca href="https://olm.operatorframework.io/docs/concepts/crds/clusterserviceversion/"\u003eClusterServiceVersion\u003c/a\u003e (\u0026ldquo;CSV\u0026rdquo;) in the controller\u0026rsquo;s bundle.\nThe file should live at \u003ccode\u003e./olm/olmconfig.yaml\u003c/code\u003e in the project structure of a controller. It should also contain a sample for each \u003ccode\u003eCustomResource\u003c/code\u003e\nmanaged by the controller. Please see the S3 controller\u0026rsquo;s \u003ccode\u003eolmconfig.yaml\u003c/code\u003e found\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller/blob/main/olm/olmconfig.yaml"\u003ehere\u003c/a\u003e for proper formatting.\u003c/p\u003e\n\u003ch2 id="validate-the-generated-csv"\u003eValidate the Generated CSV\u003c/h2\u003e\n\u003cp\u003eAfter the \u003ccode\u003eolmconfig.yaml\u003c/code\u003e has been generated it\u0026rsquo;s a good practice to validate that the CSV for the controller looks\nas expected, this ensures proper AWS branding for the controller. This does not need to be done after ever change to the\ncontroller, but if changes to the \u003ccode\u003eolmconfig.yaml\u003c/code\u003e are done, or a new CR is added to the controller, it\u0026rsquo;s best to validate that\nthe new changes in the CSV appears as expected.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003eBuild the controller locally using the \u003ccode\u003ecode-generator\u003c/code\u003e project\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eInstall Operator SDK in the \u003ccode\u003ecode-generator\u003c/code\u003e \u003ccode\u003e/bin\u003c/code\u003e directory using the below script\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ ./scripts/install-operator-sdk.sh\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003eTarget the appropriate controller\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ export SERVICE=s3\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003eBuild the controller and generate the bundle\n\u003col\u003e\n\u003cli\u003e\u003ccode\u003e$ ACK_GENERATE_OLM=true make build-controller SERVICE=$SERVICE\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eValidate that the CSV was generated\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eUnless overridden, the CSV will be at \u003ccode\u003e$GOPATH/src/github.com/aws-controllers-k8s/s3-controller/olm/bundle/manifests/ack-s3-controller.clusterserviceversion.yaml\u003c/code\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe CSV can be \u003ca href="https://operatorhub.io/preview"\u003epreviewed\u003c/a\u003e by copying and pasting the CSV\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/operatorhub-preview.png" alt="OperatorHub.io Preview"\u003e\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="raise-pull-requests-to-community-operators-repositories"\u003eRaise Pull Requests to Community Operators Repositories\u003c/h2\u003e\n\u003cp\u003eBoth repositories rely on the same folder structure for each operator, which is laid out below. For the initial onboarding\nall that needs to be worried about is adding \u003ccode\u003e./operators/ack-new-controller\u003c/code\u003e and the \u003ccode\u003eci.yaml\u003c/code\u003e file. Since the ACK project\nreleases all the operators using semantic versioning, each ACK operator CI file will be identical, so an existing ACK operator\u0026rsquo;s\nCI file can be copied and used in the Pull Request.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003e.\n└── ack-new-controller\n ├── 0.0.1\n ├── 0.0.2\n └── ci.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003col\u003e\n\u003cli\u003eRaise a Pull Request for OperatorHub.io \u003ca href="https://github.com/k8s-operatorhub/community-operators"\u003ehere\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eBelow is a quote from this repository\u0026rsquo;s Readme file explaining its usage\n\u003cblockquote\u003e\n\u003cp\u003eThis repo is the canonical source for Kubernetes Operators that appear on \u003ca href="https://operatorhub.io"\u003eOperatorHub.io\u003c/a\u003e.\nThe solutions merged on this repository are distributed via the \u003ca href="https://github.com/operator-framework/operator-lifecycle-manager"\u003eOLM\u003c/a\u003e index catalog \u003ca href="https://quay.io/repository/operatorhubio/catalog?tag=latest\u0026amp;tab=tags"\u003equay.io/operatorhubio/catalog\u003c/a\u003e.\nUsers can install \u003ca href="https://github.com/operator-framework/operator-lifecycle-manager"\u003eOLM\u003c/a\u003e in any Kubernetes or vendor such as Openshift to consume this content by adding a new CatalogSource for the index image\n\u003ccode\u003equay.io/operatorhubio/catalog\u003c/code\u003e. \u003ca href="https://k8s-operatorhub.github.io/community-operators/testing-operators/#1-create-the-catalogsource"\u003e(more info)\u003c/a\u003e\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="2"\u003e\n\u003cli\u003eRaise a Pull Request for embedded OperatorHub in OpenShift \u003ca href="https://github.com/redhat-openshift-ecosystem/community-operators-prod"\u003ehere\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eBelow is a quote from this repository\u0026rsquo;s Readme file explaining its usage\n\u003cblockquote\u003e\n\u003cp\u003eThis repo is the canonical source for Kubernetes Operators that appear on \u003ca href="https://openshift.com"\u003eOpenShift Container Platform\u003c/a\u003e\nand \u003ca href="https://www.okd.io/"\u003eOKD\u003c/a\u003e.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe build for these Pull Requests will fail since no bundle has been provided, but that is okay, the maintainers will still review and\nmerge the pull request. After these Pull Requests have been merged, the new controller is now onboarded and ready for a release.\u003c/p\u003e\n'}).add({id:11,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/api-inference/",title:"API Inference",description:"How ACK introspects an AWS API model file",content:'\u003cp\u003eThis document discusses how ACK introspects an AWS API model file and\ndetermines which \u003ccode\u003eCustomResourceDefinition\u003c/code\u003es (CRDs) to construct and what the\nstructure of those CRDs look like.\u003c/p\u003e\n\u003ch2 id="the-kubernetes-resource-model"\u003eThe Kubernetes Resource Model\u003c/h2\u003e\n\u003cp\u003eThe \u003ca href="https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/"\u003eKubernetes Resource Model\u003c/a\u003e (KRM) is a set of \u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md"\u003estandards\u003c/a\u003e\nand naming conventions that govern how an \u003ca href="https://kubernetes.io/docs/reference/glossary/?all=true#term-object"\u003e\u003ccode\u003eObject\u003c/code\u003e\u003c/a\u003e may be created and\nupdated.\u003c/p\u003e\n\u003cp\u003eAn \u003ccode\u003eObject\u003c/code\u003e includes some metadata about the object \u0026ndash; a\n\u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#resources"\u003e\u003ccode\u003eGroupVersionKind\u003c/code\u003e\u003c/a\u003e (GVK), a \u003ccode\u003eName\u003c/code\u003e, a \u003ccode\u003eNamespace\u003c/code\u003e, and zero or more \u003ccode\u003eLabels\u003c/code\u003e\nand \u003ccode\u003eAnnotations\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eIn addition to this metadata, each \u003ccode\u003eObject\u003c/code\u003e has a \u003ccode\u003eSpec\u003c/code\u003e field which is a\nstruct that contains the \u003cstrong\u003edesired\u003c/strong\u003e state of the \u003ccode\u003eObject\u003c/code\u003e. \u003ccode\u003eObjects\u003c/code\u003e are\ntypically denoted using YAML, like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-amazing-bucket\n annotations:\n pronounced-as: boo-kay\nspec:\n name: my-amazing-bucket\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Manifests\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The YAML files containing an object definition like above are typically\ncalled \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-manifest"\u003e\u003cstrong\u003emanifests\u003c/strong\u003e\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAbove, the \u003ccode\u003eObject\u003c/code\u003e has a GVK of \u0026ldquo;s3.services.k8s.aws/v1alpha1:Bucket\u0026rdquo; with an\n\u003cstrong\u003einternal-to-Kubernetes\u003c/strong\u003e \u003ccode\u003eName\u003c/code\u003e of \u0026ldquo;my-amazing-bucket\u0026rdquo; and a single\n\u003ccode\u003eAnnotation\u003c/code\u003e key/value pair \u0026ldquo;pronounced-as: boo-kay\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eSpec\u003c/code\u003e field is a structure containing desired state fields about this\nBucket. You can see here that there is a \u003ccode\u003eSpec.Name\u003c/code\u003e field representing the\nBucket name that will be passed to the S3 CreateBucket API as the name of the\nBucket. Note that the \u003ccode\u003eMetadata.Name\u003c/code\u003e field value is the same as the\n\u003ccode\u003eSpec.Name\u003c/code\u003e field value here, but there\u0026rsquo;s nothing mandatory about this.\u003c/p\u003e\n\u003cp\u003eWhen a Kubernetes user creates an \u003ccode\u003eObject\u003c/code\u003e, typically by passing some YAML to\nthe \u003ccode\u003ekubectl create\u003c/code\u003e or \u003ccode\u003ekubectl apply\u003c/code\u003e CLI command, the Kubernetes API server\nreads the manifest and determines whether the supplied contents are valid.\u003c/p\u003e\n\u003cp\u003eIn order to determine if a manifest is valid, the Kubernetes API server must\nlook up the \u003cstrong\u003edefinition\u003c/strong\u003e of the specified \u003ccode\u003eGroupVersionKind\u003c/code\u003e. For all of the\nresources that ACK is concerned about, what this means is that the Kubernetes\nAPI server will search for the \u003ca href="https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-CustomResourceDefinition"\u003e\u003ccode\u003eCustomResourceDefinition\u003c/code\u003e\u003c/a\u003e (CRD) matching\nthe \u003ccode\u003eGroupVersionKind\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThis CRD describes the fields that comprise \u003ccode\u003eObject\u003c/code\u003es of that particular\n\u003ccode\u003eGroupVersionKind\u003c/code\u003e \u0026ndash; called \u003ccode\u003eCustomResources\u003c/code\u003e (CRs).\u003c/p\u003e\n\u003cp\u003eIn the next sections we discuss:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ehow ACK determines what will become a CRD\u003c/li\u003e\n\u003cli\u003ehow ACK determines the fields that go into each CRD\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="which-things-become-ack-resources"\u003eWhich things become ACK Resources?\u003c/h2\u003e\n\u003cp\u003eAs mentioned in the \u003ca href="../code-generation/"\u003ecode generation documentation\u003c/a\u003e, ACK reads AWS API\nmodel files when generating its API types and controller implementations. These\nmodel files are JSON files contain some important information about the\nstructure of the AWS service API, including a set of \u003cem\u003eOperation\u003c/em\u003e definitions\n(commonly called \u0026ldquo;Actions\u0026rdquo; in the official AWS API documentation) and a set of\n\u003cem\u003eShape\u003c/em\u003e definitions.\u003c/p\u003e\n\u003cp\u003eSome AWS APIs have dozens (hundreds even!) of Operations exposed by the API.\nConsider EC2\u0026rsquo;s API. It has over \u003cstrong\u003e400 separate Actions\u003c/strong\u003e. Out of all those\nOperations, how are we to tell which ones refer to something that we can model\nas a Kubernetes \u003ccode\u003eCustomResource\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, we could look at the EC2 API\u0026rsquo;s list of Operations and manually decide\nwhich ones seem \u0026ldquo;resource-y\u0026rdquo;. Operations like \u0026ldquo;AdvertiseByoipCidr\u0026rdquo; and\n\u0026ldquo;AcceptTransitGatewayVpcAttachment\u0026rdquo; don\u0026rsquo;t seem very \u0026ldquo;resource-y\u0026rdquo;. Operations\nlike \u0026ldquo;CreateKeyPair\u0026rdquo; and \u0026ldquo;DeleteKeyPair\u0026rdquo;, however, do seem like they would\nmatch a resource called \u0026ldquo;KeyPair\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eAnd this is actually how ACK decides what is a \u003ccode\u003eCustomResource\u003c/code\u003e and what isn\u0026rsquo;t.\u003c/p\u003e\n\u003cp\u003eIt uses a simple heuristic: \u003cem\u003elook through the list of Operations in the API\nmodel file and filter out the ones that start with the string \u0026ldquo;Create\u0026rdquo;. If what\ncomes after the word \u0026ldquo;Create\u0026rdquo; describes a singular noun, then we create a\n\u003ccode\u003eCustomResource\u003c/code\u003e of that \u003ccode\u003eKind\u003c/code\u003e\u003c/em\u003e.\u003c/p\u003e\n\u003cp\u003eIt really is that simple.\u003c/p\u003e\n\u003ch2 id="how-is-an-ack-resource-defined"\u003eHow is an ACK Resource Defined?\u003c/h2\u003e\n\u003cp\u003eLet\u0026rsquo;s take a look at the \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/df6183acdc5b9b8508ea2fc8ec8c39fd19301ac6/services/s3/config/crd/bases/s3.services.k8s.aws_buckets.yaml"\u003eCRD for ACK\u0026rsquo;s S3 Bucket\u003c/a\u003e (the\n\u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e \u003ccode\u003eGroupKind\u003c/code\u003e (GK)) (snipped slightly for brevity):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e---\napiVersion: apiextensions.k8s.io/v1\nkind: CustomResourceDefinition\nmetadata:\n name: buckets.s3.services.k8s.aws\nspec:\n group: s3.services.k8s.aws\n names:\n kind: Bucket\n scope: Namespaced\n versions:\n - name: v1alpha1\n schema:\n openAPIV3Schema:\n description: Bucket is the Schema for the Buckets API\n properties:\n apiVersion:\n type: string\n kind:\n type: string\n metadata:\n type: object\n spec:\n description: BucketSpec defines the desired state of Bucket\n properties:\n acl:\n type: string\n createBucketConfiguration:\n properties:\n locationConstraint:\n type: string\n type: object\n grantFullControl:\n type: string\n grantRead:\n type: string\n grantReadACP:\n type: string\n grantWrite:\n type: string\n grantWriteACP:\n type: string\n name:\n type: string\n objectLockEnabledForBucket:\n type: boolean\n required:\n - name\n type: object\n status:\n description: BucketStatus defines the observed state of Bucket\n properties:\n ackResourceMetadata:\n properties:\n arn:\n type: string\n ownerAccountID:\n type: string\n required:\n - ownerAccountID\n type: object\n conditions:\n items:\n properties:\n lastTransitionTime:\n format: date-time\n type: string\n message:\n type: string\n reason:\n type: string\n status:\n type: string\n type:\n type: string\n required:\n - status\n - type\n type: object\n type: array\n location:\n type: string\n required:\n - ackResourceMetadata\n - conditions\n type: object\n type: object\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe above YAML representation of a \u003ccode\u003eCustomResourceDefinition\u003c/code\u003e (CRD) is actually\ngenerated from a set of Go type definitions. These Go type definitions live in\neach ACK service\u0026rsquo;s \u003ccode\u003eservices/$SERVICE/apis/$VERSION\u003c/code\u003e directory.\u003c/p\u003e\n\u003cp\u003eThis section of our documentation discusses how we create those Go type\ndefinitions.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n controller-gen crd\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The OpenAPIv3 Validating Schema shown above is created by the\n[\u003ccode\u003econtroller-gen crd\u003c/code\u003e][cg] CLI command and is a convenient human-readable\nrepresentation of the \u003ccode\u003eCustomResourceDefinition\u003c/code\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe Bucket CR\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e field is defined above as containing a set of fields \u0026ndash;\n\u0026ldquo;acl\u0026rdquo;, \u0026ldquo;createBucketConfiguration\u0026rdquo;, \u0026ldquo;name\u0026rdquo;, etc. Each field has a JSONSchema\ntype that corresponds with the Go type from the associated field member.\u003c/p\u003e\n\u003cp\u003eYou will also notice that in addition to the definition of a \u003ccode\u003eSpec\u003c/code\u003e field,\nthere is also the definition of a \u003ccode\u003eStatus\u003c/code\u003e field for the Bucket CRs. Above,\nthis \u003ccode\u003eStatus\u003c/code\u003e contains fields that represent the \u0026ldquo;observed\u0026rdquo; state of the Bucket\nCRs. The above shows three fields in the Bucket\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e:\n\u003ccode\u003eackResourceMetadata\u003c/code\u003e, \u003ccode\u003econditions\u003c/code\u003e and \u003ccode\u003elocation\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eYou might be wondering how the ACK code generator determined which fields go\ninto the Bucket\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and which fields go into the Bucket\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, it\u0026rsquo;s definitely not a manual process. Everything in ACK is code-generated\nand discovered by inspecting the AWS API model files.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n What are AWS API model files?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The AWS API model files are JSON files that contain information about a\nparticular AWS service API\u0026rsquo;s Actions and Shapes. We consume the model files\n[distributed][aws-sdk-go-model-files] in the \u003ccode\u003eaws-sdk-go\u003c/code\u003e project. (Look\nfor the \u003ccode\u003eapi-2.json\u003c/code\u003e files in the linked service-specific directories\u0026hellip;)\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eLet\u0026rsquo;s take a look at a tiny bit of the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/testdata/models/apis/s3/0000-00-00/api-2.json"\u003eAWS S3 API model file\u003c/a\u003e and\nyou can start to see how we identify the things that go into the \u003ccode\u003eSpec\u003c/code\u003e and\n\u003ccode\u003eStatus\u003c/code\u003e fields.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e{\n \u0026quot;metadata\u0026quot;:{\n \u0026quot;serviceId\u0026quot;:\u0026quot;S3\u0026quot;,\n },\n \u0026quot;operations\u0026quot;:{\n \u0026quot;CreateBucket\u0026quot;:{\n \u0026quot;name\u0026quot;:\u0026quot;CreateBucket\u0026quot;,\n \u0026quot;http\u0026quot;:{\n \u0026quot;method\u0026quot;:\u0026quot;PUT\u0026quot;,\n \u0026quot;requestUri\u0026quot;:\u0026quot;/{Bucket}\u0026quot;\n },\n \u0026quot;input\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;CreateBucketRequest\u0026quot;},\n \u0026quot;output\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;CreateBucketOutput\u0026quot;},\n },\n },\n \u0026quot;shapes\u0026quot;:{\n \u0026quot;BucketCannedACL\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;string\u0026quot;,\n \u0026quot;enum\u0026quot;:[\n \u0026quot;private\u0026quot;,\n \u0026quot;public-read\u0026quot;,\n \u0026quot;public-read-write\u0026quot;,\n \u0026quot;authenticated-read\u0026quot;\n ]\n },\n \u0026quot;BucketName\u0026quot;:{\u0026quot;type\u0026quot;:\u0026quot;string\u0026quot;},\n \u0026quot;CreateBucketConfiguration\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;LocationConstraint\u0026quot;:{\u0026quot;shape\u0026quot;:\u0026quot;BucketLocationConstraint\u0026quot;}\n }\n },\n \u0026quot;CreateBucketOutput\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;Location\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;Location\u0026quot;,\n }\n }\n },\n \u0026quot;CreateBucketRequest\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;required\u0026quot;:[\u0026quot;Bucket\u0026quot;],\n \u0026quot;members\u0026quot;:{\n \u0026quot;ACL\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;BucketCannedACL\u0026quot;,\n },\n \u0026quot;Bucket\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;BucketName\u0026quot;,\n },\n \u0026quot;CreateBucketConfiguration\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;CreateBucketConfiguration\u0026quot;,\n },\n \u0026quot;GrantFullControl\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantFullControl\u0026quot;,\n },\n \u0026quot;GrantRead\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantRead\u0026quot;,\n },\n \u0026quot;GrantReadACP\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantReadACP\u0026quot;,\n },\n \u0026quot;GrantWrite\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantWrite\u0026quot;,\n },\n \u0026quot;GrantWriteACP\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;GrantWriteACP\u0026quot;,\n },\n \u0026quot;ObjectLockEnabledForBucket\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;ObjectLockEnabledForBucket\u0026quot;,\n }\n },\n },\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs mentioned above, we determine what things in an API are\n\u003ccode\u003eCustomResourceDefinition\u003c/code\u003es by looking for \u003ccode\u003eOperation\u003c/code\u003es that begin with the\nstring \u0026ldquo;Create\u0026rdquo; and where the remainder of the \u003ccode\u003eOperation\u003c/code\u003e name refers to a\n\u003cem\u003esingular\u003c/em\u003e noun.\u003c/p\u003e\n\u003cp\u003eFor the S3 API, there happens to be only a single Operation that begins with\nthe string \u0026ldquo;Create\u0026rdquo;, and it happens to be \u0026ldquo;\u003ca href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html"\u003eCreateBucket\u003c/a\u003e\u0026rdquo;.\nAnd since \u0026ldquo;Bucket\u0026rdquo; refers to a singular noun, that is the\n\u003ccode\u003eCustomResourceDefinition\u003c/code\u003e that is identified by the ACK code generator.\u003c/p\u003e\n\u003cp\u003eThe ACK code generator writes a file \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go"\u003e\u003ccode\u003eapis/v1alpha1/bucket.go\u003c/code\u003e\u003c/a\u003e\nthat contains a \u003ccode\u003eBucketSpec\u003c/code\u003e struct definition, a \u003ccode\u003eBucketStatus\u003c/code\u003e struct\ndefinition and a \u003ccode\u003eBucket\u003c/code\u003e struct definition that ties the Spec and Status\ntogether into our CRD.\u003c/p\u003e\n\u003cp\u003eIn determining the structure of the \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e CRD, the ACK\ncode generator inspects the \u003ccode\u003eShape\u003c/code\u003es referred to by the \u0026ldquo;input\u0026rdquo; and \u0026ldquo;output\u0026rdquo;\nmembers of the \u0026ldquo;CreateBucket\u0026rdquo; \u003ccode\u003eOperation\u003c/code\u003e: \u0026ldquo;CreateBucketRequest\u0026rdquo; and\n\u0026ldquo;CreateBucketOutput\u0026rdquo; respectively.\u003c/p\u003e\n\u003ch3 id="determining-the-spec-fields"\u003eDetermining the Spec fields\u003c/h3\u003e\n\u003cp\u003eFor the \u003ccode\u003eBucketSpec\u003c/code\u003e fields, we grab members of the \u003ccode\u003eInput\u003c/code\u003e shape. The\n\u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go#L23-L35"\u003egenerated Go type definition\u003c/a\u003e for the \u003ccode\u003eBucketSpec\u003c/code\u003e ends up looking\nlike this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e// BucketSpec defines the desired state of Bucket\ntype BucketSpec struct {\n ACL *string `json:\u0026quot;acl,omitempty\u0026quot;`\n CreateBucketConfiguration *CreateBucketConfiguration `json:\u0026quot;createBucketConfiguration,omitempty\u0026quot;`\n GrantFullControl *string `json:\u0026quot;grantFullControl,omitempty\u0026quot;`\n GrantRead *string `json:\u0026quot;grantRead,omitempty\u0026quot;`\n GrantReadACP *string `json:\u0026quot;grantReadACP,omitempty\u0026quot;`\n GrantWrite *string `json:\u0026quot;grantWrite,omitempty\u0026quot;`\n GrantWriteACP *string `json:\u0026quot;grantWriteACP,omitempty\u0026quot;`\n // +kubebuilder:validation:Required\n Name *string `json:\u0026quot;name\u0026quot;`\n ObjectLockEnabledForBucket *bool `json:\u0026quot;objectLockEnabledForBucket,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s take a closer look at the \u003ccode\u003eBucketSpec\u003c/code\u003e fields.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eACL\u003c/code\u003e, \u003ccode\u003eGrantFullControl\u003c/code\u003e, \u003ccode\u003eGrantRead\u003c/code\u003e, \u003ccode\u003eGrantReadACP\u003c/code\u003e, \u003ccode\u003eGrantWrite\u003c/code\u003e and\n\u003ccode\u003eGrantWriteACP\u003c/code\u003e fields are simple \u003ccode\u003e*string\u003c/code\u003e types. However, if we look at the\n\u003ccode\u003eCreateBucketRequest\u003c/code\u003e Shape definition in the API model file, we see that these\nfields actually are differently-named Shapes, not \u003ccode\u003e*string\u003c/code\u003e. Why is this? Well,\nthe ACK code generator \u0026ldquo;flattens\u0026rdquo; some Shapes when it notices that a named\nShape is just an alias for a simple scalar type (like \u003ccode\u003e*string\u003c/code\u003e).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Why \u003ccode\u003e*string\u003c/code\u003e?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The astute reader may be wondering why the Go type for string fields is\n\u003ccode\u003e*string\u003c/code\u003e and not \u003ccode\u003estring\u003c/code\u003e. The reason for this lies in \u003ccode\u003eaws-sdk-go\u003c/code\u003e. All\ntypes for all Shape members are pointer types, even when the underlying\ndata type is a simple scalar type like \u003ccode\u003ebool\u003c/code\u003e or \u003ccode\u003eint\u003c/code\u003e. Yes, even when\nthe field is required\u0026hellip;\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNote that even though the \u003ccode\u003eACL\u003c/code\u003e field has a Shape of \u003ccode\u003eBucketCannedACL\u003c/code\u003e, that\nShape is actually just a \u003ccode\u003estring\u003c/code\u003e with a set of enumerated values. Enumerated\nvalues are collected and written out by the ACK code generator into an\n\u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/enums.go"\u003e\u003ccode\u003eapis/v1alpha1/enums.go\u003c/code\u003e\u003c/a\u003e file, with content like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003etype BucketCannedACL string\n\nconst (\n BucketCannedACL_private BucketCannedACL = \u0026quot;private\u0026quot;\n BucketCannedACL_public_read BucketCannedACL = \u0026quot;public-read\u0026quot;\n BucketCannedACL_public_read_write BucketCannedACL = \u0026quot;public-read-write\u0026quot;\n BucketCannedACL_authenticated_read BucketCannedACL = \u0026quot;authenticated-read\u0026quot;\n)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003eCreateBucketConfiguration\u003c/code\u003e field is of type \u003ccode\u003e*CreateBucketConfiguration\u003c/code\u003e.\nAll this means is that the field refers to a nested struct. All struct type\ndefinitions for CRD Spec or Status field members are placed by the ACK code\ngenerator into a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/types.go"\u003e\u003ccode\u003eapis/v1alpha1/types.go\u003c/code\u003e\u003c/a\u003e file.\u003c/p\u003e\n\u003cp\u003eHere is a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/types.go#L36-L38"\u003esnippet\u003c/a\u003e of that file that contains the type definition for\nthe \u003ccode\u003eCreateBucketConfiguration\u003c/code\u003e struct:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003etype CreateBucketConfiguration struct {\n LocationConstraint *string `json:\u0026quot;locationConstraint,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow, the \u003ccode\u003eName\u003c/code\u003e field in the \u003ccode\u003eBucketSpec\u003c/code\u003e struct seems out of place, no? There\nis no \u0026ldquo;Name\u0026rdquo; member of the \u003ccode\u003eCreateBucketRequest\u003c/code\u003e Shape, so why is there a\n\u003ccode\u003eName\u003c/code\u003e field in \u003ccode\u003eBucketSpec\u003c/code\u003e?\u003c/p\u003e\n\u003cp\u003eWell, this is an example of ACK\u0026rsquo;s code generator using some special\ninstructions contained in something called the \u003ccode\u003egenerator.yaml\u003c/code\u003e (or \u0026ldquo;generator\nconfig\u0026rdquo;) for the S3 service controller.\u003c/p\u003e\n\u003cp\u003eEach service in the \u003ccode\u003eservices/\u003c/code\u003e directory can have a \u003ccode\u003egenerator.yaml\u003c/code\u003e file that\ncontains overrides and special instructions for how to interpret and transform\nparts of the service\u0026rsquo;s API.\u003c/p\u003e\n\u003cp\u003eHere is part of the \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/generator.yaml"\u003eS3 service\u0026rsquo;s \u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Bucket:\n renames:\n operations:\n CreateBucket:\n input_fields:\n Bucket: Name\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, the generator config for the ACK S3 service controller is\nrenaming the \u003ccode\u003eCreateBucket\u003c/code\u003e Operation\u0026rsquo;s Input Shape \u003ccode\u003eBucket\u003c/code\u003e field to \u003ccode\u003eName\u003c/code\u003e.\nWe do this for some APIs to add a little consistency and a more\nKubernetes-native experience for the CRDs. In Kubernetes, there is a\n\u003ccode\u003eMetadata.Name\u003c/code\u003e (internal Kubernetes name) and there is typically a \u003ccode\u003eSpec.Name\u003c/code\u003e\nfield which refers to the \u003cstrong\u003eexternal\u003c/strong\u003e Name of the resource. So, in order to\nalign the \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e\u0026rsquo;s definition to be more Kubernetes-like,\nwe rename the \u003ccode\u003eBucket\u003c/code\u003e field to \u003ccode\u003eName\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eWe do this renaming for other things that produce a bit of a\n\u0026ldquo;\u003ca href="https://github.com/aws/aws-sdk-go/blob/master/private/model/api/legacy_stutter.go"\u003estutter\u003c/a\u003e\u0026rdquo;, as well as where the name of a field does not conform to\nGo exported name constraints or \u003ca href="https://golang.org/doc/effective_go.html#names"\u003enaming best practices\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="determining-the-status-fields"\u003eDetermining the Status fields\u003c/h3\u003e\n\u003cp\u003eRemember that fields in a CR\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct are not mutable by normal\nKubernetes users. Instead, these fields represent the latest observed state of\na resource (instead of the \u003cem\u003edesired\u003c/em\u003e state of that resource which is\nrepresented by fields in the CR\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e struct).\u003c/p\u003e\n\u003cp\u003eThe ACK code generator takes the members of the Create \u003ccode\u003eOperation\u003c/code\u003e\u0026rsquo;s \u003ccode\u003eOutput\u003c/code\u003e\nshape and puts those fields into the CR\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct.\u003c/p\u003e\n\u003cp\u003eWe assume that fields in the \u003ccode\u003eOutput\u003c/code\u003e that have the same name as fields in the\n\u003ccode\u003eInput\u003c/code\u003e shape for the Create \u003ccode\u003eOperation\u003c/code\u003e refer to the resource field that was\nset in the \u003ccode\u003eSpec\u003c/code\u003e field and therefore \u003cstrong\u003eare only interested in fields in the\n\u003ccode\u003eOutput\u003c/code\u003e that are not in the \u003ccode\u003eInput\u003c/code\u003e\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eLooking at the \u003ccode\u003eBucketSpec\u003c/code\u003e struct definition that was generated after\nprocessing the S3 API model file, we find \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/services/s3/apis/v1alpha1/bucket.go#L37-L49"\u003ethis\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e// BucketStatus defines the observed state of Bucket\ntype BucketStatus struct {\n // All CRs managed by ACK have a common `Status.ACKResourceMetadata` member\n // that is used to contain resource sync state, account ownership,\n // constructed ARN for the resource\n ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:\u0026quot;ackResourceMetadata\u0026quot;`\n // All CRS managed by ACK have a common `Status.Conditions` member that\n // contains a collection of `ackv1alpha1.Condition` objects that describe\n // the various terminal states of the CR and its backend AWS service API\n // resource\n Conditions []*ackv1alpha1.Condition `json:\u0026quot;conditions\u0026quot;`\n Location *string `json:\u0026quot;location,omitempty\u0026quot;`\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s discuss each of the fields shown above.\u003c/p\u003e\n\u003cp\u003eFirst, the \u003ccode\u003eACKResourceMetadata\u003c/code\u003e field is included in \u003cstrong\u003eevery ACK CRD\u0026rsquo;s Status\nfield\u003c/strong\u003e. It is a pointer to a \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/apis/core/v1alpha1/resource_metadata.go#L16-L33"\u003e\u003ccode\u003eackv1alpha1.ResourceMetadata\u003c/code\u003e\u003c/a\u003e struct.\nThis struct contains some standard and important pieces of information about\nthe resource, including the AWS Resource Name (ARN) and the Owner AWS Account\nID.\u003c/p\u003e\n\u003cp\u003eThe ARN is a globally-unique identifier for the resource in AWS. The Owner AWS\nAccount ID is the 12-digit AWS account ID that is billed for the resource.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Cross-account resource management\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The Owner AWS Account ID for a resource \u003ca href="../../user-docs/authorization/#create-resource-in-different-aws-accounts"\u003emay be different\u003c/a\u003e from the\nAWS Account ID of the IAM Role that the ACK service controller is executing\nunder.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe \u003ccode\u003eConditions\u003c/code\u003e field is also included in every ACK CRD\u0026rsquo;s Status field. It is\na slice of pointers to \u003ca href="https://github.com/aws/aws-controllers-k8s/blob/a10e9fc4f201129765260fa4f6751a6c9421bc31/apis/core/v1alpha1/conditions.go#L37-L54"\u003e\u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e\u003c/a\u003e structs. The\n\u003ccode\u003eCondition\u003c/code\u003e struct is responsible for conveying information about the latest\nobserved sync state of a resource, including any terminal condition states that\ncause the resource to be \u0026ldquo;unsyncable\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eNext is the \u003ccode\u003eLocation\u003c/code\u003e field. This field gets its definition from the S3\n\u003ccode\u003eCreateBucketOutput.Location\u003c/code\u003e field:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e \u0026quot;CreateBucketOutput\u0026quot;:{\n \u0026quot;type\u0026quot;:\u0026quot;structure\u0026quot;,\n \u0026quot;members\u0026quot;:{\n \u0026quot;Location\u0026quot;:{\n \u0026quot;shape\u0026quot;:\u0026quot;Location\u0026quot;,\n }\n }\n },\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:12,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/resource-crud/",title:"Create an ACK Resource",description:"Create, Update and Delete an S3 bucket",content:'\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eWhile this guide provides examples for managing S3 bucket, you can find sample\nmanifest files for other AWS services in \u003ccode\u003etest/e2e/resources\u003c/code\u003e directory of\ncorresponding service controller\u0026rsquo;s GitHub repository. For example: Sample manifest\nfor ecr repository can be found \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/tree/main/test/e2e/resources"\u003ehere\u003c/a\u003e\u003c/p\u003e\n\u003cp\u003eYou can find API Reference for all the services supported by ACK \u003ca href="../../../reference"\u003ehere\u003c/a\u003e\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="create-an-s3-bucket"\u003eCreate an S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport BUCKET_NAME=my-ack-s3-bucket-$AWS_ACCOUNT_ID\n\nread -r -d \'\' BUCKET_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: $BUCKET_NAME\nspec:\n name: $BUCKET_NAME\nEOF\n\necho \u0026quot;${BUCKET_MANIFEST}\u0026quot; \u0026gt; bucket.yaml\n\nkubectl create -f bucket.yaml\n\nkubectl describe bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="update-the-s3-bucket"\u003eUpdate the S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eread -r -d \'\' BUCKET_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: $BUCKET_NAME\nspec:\n name: $BUCKET_NAME\n tagging:\n tagSet:\n - key: myTagKey\n value: myTagValue\nEOF\n\necho \u0026quot;${BUCKET_MANIFEST}\u0026quot; \u0026gt; bucket.yaml\n\nkubectl apply -f bucket.yaml\n\nkubectl describe bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-the-s3-bucket"\u003eDelete the S3 bucket\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f bucket.yaml\n\n# verify the bucket no longer exists\nkubectl get bucket/$BUCKET_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that you have verified ACK service controller functionality, \u003ca href="../multi-region-resource-management"\u003echeckout ACK\nfunctionality for creating resources in multiple AWS regions.\u003c/a\u003e\u003c/p\u003e\n'}).add({id:13,href:"https://aws-controllers-k8s.github.io/community/docs/community/discussions/",title:"Discussions",description:"",content:'\u003cp\u003eFor discussions, please use the \u003ccode\u003e#aws-controllers-k8s\u003c/code\u003e channel on the \u003ca href="https://kubernetes.slack.com/"\u003eKubernetes Slack community\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:14,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/sagemaker-example/",title:"Machine Learning with the ACK SageMaker Controller",description:"Train a machine learning model with the ACK service controller for Amazon SageMaker using Amazon Elastic Kubernetes Service",content:'\u003cp\u003eThe SageMaker ACK service controller makes it easier for machine learning developers and data scientists who use Kubernetes as their control plane to train, tune, and deploy machine learning models in Amazon SageMaker without logging into the SageMaker console.\u003c/p\u003e\n\u003cp\u003eThe following steps will guide you through the setup and use of the Amazon SageMaker ACK service controller for training a machine learning model.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq"\u003eyq\u003c/a\u003e - A command line tool for YAML processing. (For Linux environments, use the \u003ca href="https://github.com/mikefarah/yq/#wget"\u003e\u003ccode\u003ewget\u003c/code\u003e plain binary installation\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://everything.curl.dev/get"\u003ecurl\u003c/a\u003e - A command line tool for transmitting data with URLs.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role and attach an IAM policy to that role to ensure that your SageMaker service controller has access to the appropriate AWS resources. First, check to make sure that you are connected to an Amazon EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport CLUSTER_NAME=\u0026lt;CLUSTER_NAME\u0026gt;\nexport SERVICE_REGION=\u0026lt;CLUSTER_REGION\u0026gt;\naws eks update-kubeconfig --name $CLUSTER_NAME --region $SERVICE_REGION\nkubectl config get-contexts\n# Ensure cluster has compute\nkubectl get nodes\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBefore you can deploy your SageMaker service controller using an IAM role, associate an OpenID Connect (OIDC) provider with your IAM role to authenticate your cluster with the IAM service.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eeksctl utils associate-iam-oidc-provider --cluster ${CLUSTER_NAME} \\\n--region ${SERVICE_REGION} --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following OIDC information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport OIDC_PROVIDER_URL=$(aws eks describe-cluster --name $CLUSTER_NAME --region $SERVICE_REGION \\\n--query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | cut -c9-)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn your working directory, create a file named \u003ccode\u003etrust.json\u003c/code\u003e using the following trust relationship code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':oidc-provider/\'$OIDC_PROVIDER_URL\'\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;\'$OIDC_PROVIDER_URL\':aud\u0026quot;: \u0026quot;sts.amazonaws.com\u0026quot;,\n \u0026quot;\'$OIDC_PROVIDER_URL\':sub\u0026quot;: [\n \u0026quot;system:serviceaccount:ack-system:ack-sagemaker-controller\u0026quot;,\n \u0026quot;system:serviceaccount:ack-system:ack-applicationautoscaling-controller\u0026quot;\n ]\n }\n }\n }\n ]\n}\n\' \u0026gt; ./trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003eiam create-role\u003c/code\u003e command to create an IAM role with the trust relationship you just defined in \u003ccode\u003etrust.json\u003c/code\u003e. This IAM role enables the Amazon EKS cluster to get and refresh credentials from IAM.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport OIDC_ROLE_NAME=ack-controller-role-$CLUSTER_NAME\naws --region $SERVICE_REGION iam create-role --role-name $OIDC_ROLE_NAME --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the AmazonSageMakerFullAccess Policy to the IAM Role to ensure that your SageMaker service controller has access to the appropriate resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam attach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\nexport IAM_ROLE_ARN_FOR_IRSA=$(aws --region $SERVICE_REGION iam get-role --role-name $OIDC_ROLE_NAME --output text --query \'Role.Arn\')\necho $IAM_ROLE_ARN_FOR_IRSA\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003ccode\u003eAmazonSageMakerFullAccess\u003c/code\u003e policy does not include permissions required to manage Domain, UserProfile or App resource. Create and attach the following Policy to the IAM Role to ensure that your SageMaker service controller has access to these resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Sid\u0026quot;: \u0026quot;SagemakerStudioAccess\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sagemaker:*\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sagemaker:*:*:domain/*\u0026quot;,\n \u0026quot;arn:aws:sagemaker:*:*:user-profile/*\u0026quot;,\n \u0026quot;arn:aws:sagemaker:*:*:app/*\u0026quot;\n ]\n }\n ]\n}\n\' \u0026gt; ./sagemaker_studio_access.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam put-role-policy --role-name $OIDC_ROLE_NAME --policy-name SagemakerStudioAccess --policy-document file://sagemaker_studio_access.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor more information on authorization and access for ACK service controllers, including details regarding recommended IAM policies, see \u003ca href="../../user-docs/authorization/"\u003eConfigure Permissions\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IAM role permissions for SageMaker resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you want to give more granular permissions, the full list of permissions required for each SageMaker resource can be found here : \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html"\u003eSageMaker API permissions\u003c/a\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="install-the-sagemaker-ack-service-controller"\u003eInstall the SageMaker ACK service controller\u003c/h3\u003e\n\u003cp\u003eGet the SageMaker Helm chart and make it available on the client machine with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport HELM_EXPERIMENTAL_OCI=1\nexport SERVICE=sagemaker\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\n\nif [[ -z \u0026quot;$RELEASE_VERSION\u0026quot; ]]; then\n RELEASE_VERSION=v1.2.0\nfi\n\nexport CHART_EXPORT_PATH=/tmp/chart\nexport CHART_REF=$SERVICE-chart\nexport CHART_REPO=public.ecr.aws/aws-controllers-k8s/$CHART_REF\nexport CHART_PACKAGE=$CHART_REF-$RELEASE_VERSION.tgz\n\nmkdir -p $CHART_EXPORT_PATH\n\nhelm pull oci://$CHART_REPO --version $RELEASE_VERSION -d $CHART_EXPORT_PATH\ntar xvf $CHART_EXPORT_PATH/$CHART_PACKAGE -C $CHART_EXPORT_PATH\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdate the Helm chart values for a cluster-scoped installation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the following values in the Helm chart\ncd $CHART_EXPORT_PATH/$SERVICE-chart\nyq e \'.aws.region = env(SERVICE_REGION)\' -i values.yaml\nyq e \'.serviceAccount.annotations.\u0026quot;eks.amazonaws.com/role-arn\u0026quot; = env(IAM_ROLE_ARN_FOR_IRSA)\' -i values.yaml\ncd -\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall the relevant custom resource definitions (CRDs) for the SageMaker ACK service controller.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a namespace and install the SageMaker ACK service controller with the Helm chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_K8S_NAMESPACE=ack-system\nhelm install -n $ACK_K8S_NAMESPACE --create-namespace --skip-crds ack-$SERVICE-controller \\\n $CHART_EXPORT_PATH/$SERVICE-chart\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the CRDs and Helm charts were deployed with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get crds | grep \u0026quot;services.k8s.aws\u0026quot;\nkubectl get pods -n $ACK_K8S_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="train-an-xgboost-model"\u003eTrain an XGBoost model\u003c/h2\u003e\n\u003ch3 id="prepare-your-data"\u003ePrepare your data\u003c/h3\u003e\n\u003cp\u003eFor training a model with SageMaker, we will need an S3 bucket to store the dataset and model training artifacts. For this example, we will use \u003ca href="http://yann.lecun.com/exdb/mnist/"\u003eMNIST\u003c/a\u003e data stored in \u003ca href="https://www.csie.ntu.edu.tw/~cjlin/libsvm/"\u003eLIBSVM\u003c/a\u003e format.\u003c/p\u003e\n\u003cp\u003eFirst, create a variable for the S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport SAGEMAKER_BUCKET=ack-sagemaker-bucket-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen, create a file named \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e with the following code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\n#!/usr/bin/env bash\n# Create the S3 bucket\nif [[ $SERVICE_REGION != \u0026quot;us-east-1\u0026quot; ]]; then\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot; --create-bucket-configuration LocationConstraint=\u0026quot;$SERVICE_REGION\u0026quot;\nelse\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot;\nfi\' \u0026gt; ./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e script to create an S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003echmod +x create-bucket.sh\n./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCopy the MNIST data into your S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ewget https://raw.githubusercontent.com/aws-controllers-k8s/sagemaker-controller/main/samples/training/s3_sample_data.py\npython3 s3_sample_data.py $SAGEMAKER_BUCKET\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="configure-permissions-for-your-training-job"\u003eConfigure permissions for your training job\u003c/h3\u003e\n\u003cp\u003eThe SageMaker training job that we execute will need an IAM role to access Amazon S3 and Amazon SageMaker. Run the following commands to create a SageMaker execution IAM role that will be used by SageMaker to access the appropriate AWS resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SAGEMAKER_EXECUTION_ROLE_NAME=ack-sagemaker-execution-role-$ACCOUNT_ID\n\nTRUST=\u0026quot;{ \\\u0026quot;Version\\\u0026quot;: \\\u0026quot;2012-10-17\\\u0026quot;, \\\u0026quot;Statement\\\u0026quot;: [ { \\\u0026quot;Effect\\\u0026quot;: \\\u0026quot;Allow\\\u0026quot;, \\\u0026quot;Principal\\\u0026quot;: { \\\u0026quot;Service\\\u0026quot;: \\\u0026quot;sagemaker.amazonaws.com\\\u0026quot; }, \\\u0026quot;Action\\\u0026quot;: \\\u0026quot;sts:AssumeRole\\\u0026quot; } ] }\u0026quot;\naws iam create-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --assume-role-policy-document \u0026quot;$TRUST\u0026quot;\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\n\nSAGEMAKER_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --output text --query \'Role.Arn\')\n\necho $SAGEMAKER_EXECUTION_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-sagemaker-training-job"\u003eCreate a SageMaker training job\u003c/h3\u003e\n\u003cp\u003eGive your SageMaker training job a unique name:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport JOB_NAME=ack-xgboost-training-job-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSpecify your region-specific XGBoost image URI:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport XGBOOST_IMAGE=683313688378.dkr.ecr.us-east-1.amazonaws.com/sagemaker-xgboost:1.2-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Change XGBoost image URI based on region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eIMPORTANT\u003c/strong\u003e: If your \u003ccode\u003eSERVICE_REGION\u003c/code\u003e is not \u003ccode\u003eus-east-1\u003c/code\u003e, you must change the \u003ccode\u003eXGBOOST_IMAGE\u003c/code\u003e URI. To find your region-specific XGBoost image URI, choose your region in the \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html"\u003eSageMaker Docker Registry Paths page\u003c/a\u003e, and then select \u003cstrong\u003eXGBoost (algorithm)\u003c/strong\u003e. For this example, use version 1.2-1.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, create a \u003ccode\u003etraining.yaml\u003c/code\u003e file to specify the parameters for your SageMaker training job. This file specifies your SageMaker training job name, any relevant hyperparameters, and the location of your training and validation data. You can also use this document to specify which Amazon Elastic Container Registry (ECR) image to use for training.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eprintf \'\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: TrainingJob\nmetadata:\n name: \'$JOB_NAME\'\nspec:\n # Name that will appear in the SageMaker console\n trainingJobName: \'$JOB_NAME\'\n hyperParameters: \n max_depth: \u0026quot;5\u0026quot;\n gamma: \u0026quot;4\u0026quot;\n eta: \u0026quot;0.2\u0026quot;\n min_child_weight: \u0026quot;6\u0026quot;\n objective: \u0026quot;multi:softmax\u0026quot;\n num_class: \u0026quot;10\u0026quot;\n num_round: \u0026quot;10\u0026quot;\n algorithmSpecification:\n # The URL and tag of your ECR container\n trainingImage: \'$XGBOOST_IMAGE\'\n trainingInputMode: File\n # A role with SageMaker and S3 access\n roleARN: \'$SAGEMAKER_EXECUTION_ROLE_ARN\' \n outputDataConfig:\n # The output path of your model\n s3OutputPath: s3://\'$SAGEMAKER_BUCKET\' \n resourceConfig:\n instanceCount: 1\n instanceType: ml.m4.xlarge\n volumeSizeInGB: 5\n stoppingCondition:\n maxRuntimeInSeconds: 86400\n inputDataConfig:\n - channelName: train\n dataSource:\n s3DataSource:\n s3DataType: S3Prefix\n # The input path of your train data \n s3URI: s3://\'$SAGEMAKER_BUCKET\'/sagemaker/xgboost/train\n s3DataDistributionType: FullyReplicated\n contentType: text/libsvm\n compressionType: None\n - channelName: validation\n dataSource:\n s3DataSource:\n s3DataType: S3Prefix\n # The input path of your validation data \n s3URI: s3://\'$SAGEMAKER_BUCKET\'/sagemaker/xgboost/validation\n s3DataDistributionType: FullyReplicated\n contentType: text/libsvm\n compressionType: None\n\' \u0026gt; ./training.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUse your \u003ccode\u003etraining.yaml\u003c/code\u003e file to create a SageMaker training job:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f training.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your \u003ccode\u003etraining.yaml\u003c/code\u003e file, you should see that your training job was successfully created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003etrainingjob.sagemaker.services.k8s.aws/ack-xgboost-training-job-7420 created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can watch the status of the training job with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get trainingjob.sagemaker --watch\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIt will a take a few minutes for \u003ccode\u003eTRAININGJOBSTATUS\u003c/code\u003e to be \u003ccode\u003eCompleted\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SECONDARYSTATUS TRAININGJOBSTATUS\nack-xgboost-training-job-7420 Starting InProgress\nack-xgboost-training-job-7420 Downloading InProgress\nack-xgboost-training-job-7420 Training InProgress\nack-xgboost-training-job-7420 Completed Completed\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo see details about your training job, run the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe trainingjobs $JOB_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf your training job completed successfully, you can find the model location under \u003ccode\u003estatus.modelArtifacts.s3ModelArtifacts\u003c/code\u003e. If your training job failed, look to the \u003ccode\u003estatus.failureReason\u003c/code\u003e for more information.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eFor more examples on how to use the SageMaker ACK service controller, see the \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/tree/main/samples"\u003eSageMaker controller samples repository\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo deploy your trained SageMaker model and scale it with the Application Auto Scaling ACK service controller, see \u003ca href="../autoscaling-example/"\u003eScale SageMaker Workloads with Application Auto Scaling\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your SageMaker training job with the \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete trainingjob $JOB_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SageMaker ACK service controller, related CRDs, and namespaces see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIt is recommended to delete any additional resources such as S3 buckets, IAM roles, and IAM policies when you no longer need them. You can delete these resources with the following commands or directly in the AWS console.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Delete S3 bucket\naws s3 rb s3://$SAGEMAKER_BUCKET --force\n\n# Delete SageMaker execution role\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\naws iam delete-role --role-name $SAGEMAKER_EXECUTION_ROLE_NAME\n\n# Delete IAM role created for IRSA\naws iam detach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam delete-role --role-name $OIDC_ROLE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:15,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/multi-region-resource-management/",title:"Manage Resources In Multiple Regions",description:"Managing resources in multiple AWS regions",content:'\u003cp\u003eYou can manage resources in multiple AWS regions using a single ACK service controller. To determine the AWS region for a given resource, the ACK service controller looks for region information in the following order:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eThe region annotation \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e on the resource.\u003c/li\u003e\n\u003cli\u003eThe region annotation \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e on the resource\u0026rsquo;s namespace.\u003c/li\u003e\n\u003cli\u003eThe \u003ccode\u003e--aws-region\u003c/code\u003e controller flag. This flag may be set using the \u003ccode\u003eaws.region\u003c/code\u003e Helm chart variable.\u003c/li\u003e\n\u003cli\u003eKubernetes pod \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003eIRSA\u003c/a\u003e environment variables.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eFor example, the \u003ccode\u003e--aws-region\u003c/code\u003e ACK service controller flag is \u003ccode\u003eus-west-2\u003c/code\u003e. If you want to create a resource in \u003ccode\u003eus-east-1\u003c/code\u003e, use one of the following options to override the default region.\u003c/p\u003e\n\u003ch2 id="option-1-region-annotation"\u003eOption 1: Region annotation\u003c/h2\u003e\n\u003cp\u003eAdd the \u003ccode\u003eservices.k8s.aws/region\u003c/code\u003e annotation while creating the resource. For example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n annotations:\n services.k8s.aws/region: us-east-1\nspec:\n name: my-bucket\n ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="option-2-namespace-default-region-annotation"\u003eOption 2: Namespace default region annotation\u003c/h2\u003e\n\u003cp\u003eTo bind a region to a specific namespace, you will have to annotate the namespace with the \u003ccode\u003eservices.k8s.aws/default-region\u003c/code\u003e annotation.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Namespace-scoped deployment does not support this option\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Use this solution for multi-region resource management on cluster-scoped deployments.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Namespace\nmetadata:\n name: production\n annotations:\n services.k8s.aws/default-region: us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor existing namespaces, you can run:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl annotate namespace production services.k8s.aws/default-region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can also create the resource in the same namespace:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n namespace: production\nspec:\n name: my-bucket\n ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eCheckout ACK functionality for \u003ca href="../cross-account-resource-management"\u003ecreating resources in multiple AWS accounts from single controller installation.\u003c/a\u003e\u003c/p\u003e\n'}).add({id:16,href:"https://aws-controllers-k8s.github.io/community/docs/community/services/",title:"Services",description:"Project status of each supported service",content:'\u003cp\u003eThe following AWS service APIs have service controllers included in ACK or have\ncontrollers in one of our \u003ca href="../releases#project-stages"\u003eseveral project stages\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eACK controllers that have reached the \u003ccode\u003eRELEASED\u003c/code\u003e project stage will also be in\none of our \u003ca href="../releases#maintenance-phases"\u003emaintenance phases\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFor details, including a list of planned AWS service APIs, see the \u003ca href="https://github.com/aws-controllers-k8s/community/projects/1"\u003eService\nController Release Roadmap\u003c/a\u003e:\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-danger"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IMPORTANT\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n There is no single release of the ACK project. The ACK project contains a\nseries of service controllers, one for each AWS service API. Each\nindividual ACK service controller is released separately. Please see the\n\u003ca href="../releases"\u003erelease documentation\u003c/a\u003e for information on how we version and\nrelease ACK service controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth style="text-align:left"\u003eMaintenance Phase\u003c/th\u003e\n\u003cth style="text-align:right"\u003e# Services\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:left"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e18\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:left"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e20\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth style="text-align:right"\u003eAWS Service\u003c/th\u003e\n\u003cth style="text-align:right"\u003eProject Stage\u003c/th\u003e\n\u003cth style="text-align:right"\u003eMaintenance Phase\u003c/th\u003e\n\u003cth style="text-align:right"\u003eLatest Version\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-acm"\u003eACM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/acm-controller/releases/tag/v0.0.14"\u003e0.0.14\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-prometheus-service"\u003ePrometheus Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/prometheusservice-controller/releases/tag/v1.2.9"\u003e1.2.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-api-gateway"\u003eAPI Gateway\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-apigatewayv2"\u003eApiGatewayV2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/releases/tag/v1.0.10"\u003e1.0.10\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-application-auto-scaling"\u003eApplication Auto Scaling\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller/releases/tag/v1.0.12"\u003e1.0.12\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-app-runner"\u003eApp Runner\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-athena"\u003eAthena\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-auto-scaling-plans"\u003eAuto Scaling Plans\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-auto-scaling"\u003eAuto Scaling\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-backup"\u003eBackup\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudfront"\u003eCloudFront\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudfront-controller/releases/tag/v0.0.9"\u003e0.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudtrail"\u003eCloudTrail\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudtrail-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cognito-identity-provider"\u003eCognito Identity Provider\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-dynamodb"\u003eDynamoDB\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/releases/tag/v1.2.9"\u003e1.2.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ec2"\u003eEC2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/releases/tag/v1.2.4"\u003e1.2.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ecr"\u003eECR\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/releases/tag/v1.0.13"\u003e1.0.13\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ecs"\u003eECS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/ecs-controller/releases/tag/v0.0.4"\u003e0.0.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-eks"\u003eEKS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/eks-controller/releases/tag/v1.3.2"\u003e1.3.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-elasticache"\u003eElastiCache\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller/releases/tag/v0.0.29"\u003e0.0.29\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-efs"\u003eEFS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/efs-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ses"\u003eSES\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-emr-containers"\u003eEMR Containers\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/emrcontainers-controller/releases/tag/v1.0.8"\u003e1.0.8\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-elasticsearch-service"\u003eElasticsearch Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/elasticsearchservice-controller/releases/tag/v0.0.2"\u003e0.0.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-eventbridge"\u003eEventBridge\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-fsx"\u003eFSx\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-iam"\u003eIAM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/iam-controller/releases/tag/v1.3.5"\u003e1.3.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kafka"\u003eKafka\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kafka-controller/releases/tag/v0.0.4"\u003e0.0.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-keyspaces"\u003eKeyspaces\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/keyspaces-controller/releases/tag/v0.0.11"\u003e0.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kinesis"\u003eKinesis\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kinesis-controller/releases/tag/v0.0.13"\u003e0.0.13\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-kms"\u003eKMS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/kms-controller/releases/tag/v1.0.11"\u003e1.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-lambda"\u003eLambda\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/releases/tag/v1.4.2"\u003e1.4.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudwatch-logs"\u003eCloudWatch Logs\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudwatchlogs-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-memorydb"\u003eMemoryDB\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/releases/tag/v1.0.2"\u003e1.0.2\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-cloudwatch"\u003eCloudWatch\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/cloudwatch-controller/releases/tag/v0.0.6"\u003e0.0.6\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-mq"\u003eMQ\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/mq-controller/releases/tag/v0.0.32"\u003e0.0.32\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-neptune"\u003eNeptune\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-network-firewall"\u003eNetwork Firewall\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/networkfirewall-controller/releases/tag/v0.0.3"\u003e0.0.3\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-opensearch-service"\u003eOpenSearch Service\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/opensearchservice-controller/releases/tag/v0.0.22"\u003e0.0.22\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-organizations"\u003eOrganizations\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/organizations-controller/releases/tag/v0.0.4"\u003e0.0.4\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ram"\u003eRAM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-recycle-bin"\u003eRecycle Bin\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-rds"\u003eRDS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/rds-controller/releases/tag/v1.2.1"\u003e1.2.1\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-route-53"\u003eRoute 53\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/route53-controller/releases/tag/v0.0.12"\u003e0.0.12\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-route53resolver"\u003eRoute53Resolver\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/route53resolver-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-s3"\u003eS3\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/s3-controller/releases/tag/v1.0.10"\u003e1.0.10\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sagemaker"\u003eSageMaker\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/releases/tag/v1.2.7"\u003e1.2.7\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-secrets-manager"\u003eSecrets Manager\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/secretsmanager-controller/releases/tag/v0.0.5"\u003e0.0.5\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-service-catalog"\u003eService Catalog\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sns"\u003eSNS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sns-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-sqs"\u003eSQS\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sqs-controller/releases/tag/v1.0.11"\u003e1.0.11\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-ssm"\u003eSSM\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAWS \u003ca href="#aws-sfn"\u003eSFN\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ca href="https://github.com/aws-controllers-k8s/sfn-controller/releases/tag/v1.0.9"\u003e1.0.9\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd style="text-align:right"\u003eAmazon \u003ca href="#amazon-wafv2"\u003eWAFV2\u003c/a\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003e\u003ccode\u003eNONE\u003c/code\u003e\u003c/td\u003e\n\u003ctd style="text-align:right"\u003en/a\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Don\u0026rsquo;t see a service listed?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you don\u0026rsquo;t see a particular AWS service listed, feel free to\n\u003ca href="https://github.com/aws-controllers-k8s/community/issues/new?labels=Service+Controller\u0026amp;template=propose_new_controller.md\u0026amp;title=%5Bname%5D+service+controller"\u003epropose it\u003c/a\u003e!\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="amazon-acm"\u003eAmazon ACM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/acm-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/acm-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/482" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/482\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/acm-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/acm-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-prometheus-service"\u003eAmazon Prometheus Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/prometheusservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/prometheusservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/prometheusservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/prometheusservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-api-gateway"\u003eAmazon API Gateway\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/apigateway-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/apigateway-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1126" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1126\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-apigatewayv2"\u003eAmazon ApiGatewayV2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/apigatewayv2-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/apigatewayv2-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/apigatewayv2-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-application-auto-scaling"\u003eAmazon Application Auto Scaling\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/applicationautoscaling-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/applicationautoscaling-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/applicationautoscaling-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-app-runner"\u003eAWS App Runner\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1616" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1616\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-athena"\u003eAmazon Athena\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1597" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1597\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-auto-scaling-plans"\u003eAWS Auto Scaling Plans\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/590" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/590\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-auto-scaling"\u003eAmazon Auto Scaling\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/autoscaling-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/autoscaling-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/588" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/588\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-backup"\u003eAWS Backup\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/2023" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/2023\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudfront"\u003eAmazon CloudFront\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudfront-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudfront-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/249" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/249\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudfront-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudfront-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudtrail"\u003eAmazon CloudTrail\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudtrail-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudtrail-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudtrail-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudtrail-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cognito-identity-provider"\u003eAmazon Cognito Identity Provider\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1211" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1211\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-dynamodb"\u003eAmazon DynamoDB\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/dynamodb-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/dynamodb-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/dynamodb-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ec2"\u003eAmazon EC2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ec2-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/490" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/490\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ec2-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ec2-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ecr"\u003eAmazon ECR\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ecr-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecr-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecr-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ecs"\u003eAmazon ECS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ecs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ecs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1592" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1592\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/ecs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-eks"\u003eAmazon EKS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/eks-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/eks-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eks-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eks-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-elasticache"\u003eAmazon ElastiCache\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/elasticache-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/240" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/240\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticache-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticache-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-efs"\u003eAmazon EFS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/efs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/efs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/328" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/328\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/efs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/efs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ses"\u003eAmazon SES\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/493" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/493\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-emr-containers"\u003eAmazon EMR Containers\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/emrcontainers-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/emrcontainers-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/emrcontainers-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/emrcontainers-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-elasticsearch-service"\u003eAmazon Elasticsearch Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/elasticsearchservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/elasticsearchservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticsearchservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/elasticsearchservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-eventbridge"\u003eAmazon EventBridge\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/eventbridge-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eventbridge-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/eventbridge-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-fsx"\u003eAmazon FSx\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1485" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1485\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-iam"\u003eAmazon IAM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/iam-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/iam-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/iam-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/iam-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kafka"\u003eAmazon Kafka\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kafka-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kafka-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/348" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/348\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kafka-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kafka-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-keyspaces"\u003eAmazon Keyspaces\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/keyspaces-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/keyspaces-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1801" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1801\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/keyspaces-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/keyspaces-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kinesis"\u003eAmazon Kinesis\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kinesis-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kinesis-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/235" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/235\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kinesis-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kinesis-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-kms"\u003eAmazon KMS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/kms-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/kms-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kms-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/kms-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-lambda"\u003eAWS Lambda\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/lambda-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/lambda-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/lambda-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudwatch-logs"\u003eAmazon CloudWatch Logs\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudwatchlogs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudwatchlogs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatchlogs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatchlogs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-memorydb"\u003eAmazon MemoryDB\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/memorydb-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/memorydb-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/memorydb-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-cloudwatch"\u003eAmazon CloudWatch\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/cloudwatch-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/cloudwatch-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1093" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1093\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatch-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/cloudwatch-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-mq"\u003eAmazon MQ\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/mq-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/mq-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/390" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/390\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/mq-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/mq-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-neptune"\u003eAmazon Neptune\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1768" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1768\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-network-firewall"\u003eAmazon Network Firewall\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/networkfirewall-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/networkfirewall-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/networkfirewall-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/networkfirewall-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-opensearch-service"\u003eAmazon OpenSearch Service\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/opensearchservice-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/opensearchservice-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/opensearchservice-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/opensearchservice-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-organizations"\u003eAmazon Organizations\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/organizations-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/organizations-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/716" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/716\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/organizations-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/organizations-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ram"\u003eAmazon RAM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/492" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/492\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-recycle-bin"\u003eAmazon Recycle Bin\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1870" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1870\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-rds"\u003eAmazon RDS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/rds-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/rds-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/rds-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/rds-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-route-53"\u003eAmazon Route 53\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/route53-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/route53-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/480" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/480\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-route53resolver"\u003eAmazon Route53Resolver\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/route53resolver-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/route53resolver-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1853" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1853\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53resolver-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/route53resolver-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-s3"\u003eAmazon S3\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/s3-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/s3-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sagemaker"\u003eAmazon SageMaker\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sagemaker-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sagemaker-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sagemaker-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-secrets-manager"\u003eAWS Secrets Manager\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/secretsmanager-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/secretsmanager-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003ePREVIEW\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/628" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/628\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/secretsmanager-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/secretsmanager-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-service-catalog"\u003eAWS Service Catalog\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/servicecatalog-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/servicecatalog-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1026" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1026\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sns"\u003eAmazon SNS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sns-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sns-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sns-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sns-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-sqs"\u003eAmazon SQS\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sqs-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sqs-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sqs-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sqs-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-ssm"\u003eAmazon SSM\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/ssm-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/ssm-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePLANNED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/485" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/485\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="aws-sfn"\u003eAWS SFN\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: \u003ca href="https://github.com/aws-controllers-k8s/sfn-controller" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/sfn-controller\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003eRELEASED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eGENERAL AVAILABILITY\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eContainer URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sfn-controller\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eHelm Chart URI: \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/sfn-chart\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="amazon-wafv2"\u003eAmazon WAFV2\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eACK service controller: None\u003c/li\u003e\n\u003cli\u003eCurrent project stage: \u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCurrent maintenance phase: \u003ccode\u003eNONE\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eController proposal: \u003ca href="https://github.com/aws-controllers-k8s/community/issues/1300" rel="noopener"\u003ehttps://github.com/aws-controllers-k8s/community/issues/1300\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:17,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/setup/",title:"Setup",description:"Setting up the development environment",content:'\u003cp\u003eWe walk you now through the setup to start contributing to the AWS Controller\nfor Kubernetes (ACK) project. No matter if you\u0026rsquo;re contributing code or docs,\nfollow the steps below to set up your development environment.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-success"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Issue before PR\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Of course we\u0026rsquo;re happy about code drops via PRs, however, in order to give\nus time to plan ahead and also to avoid disappointment, consider creating\nan issue first and submit a PR later. This also helps us to coordinate\nbetween different contributors and should in general help keeping everyone\nhappy.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003ePlease ensure that you have \u003ca href="https://golang.org/doc/install"\u003eproperly installed Go\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Go version\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Our repositories require a Go version of \u003ccode\u003e1.19\u003c/code\u003e or above for development.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="fork-upstream-repositories"\u003eFork upstream repositories\u003c/h2\u003e\n\u003cp\u003eThe first step in setting up your ACK development environment is to fork the\nupstream ACK source code repositories to your personal Github account.\u003c/p\u003e\n\u003cp\u003eThere are three common upstream repositories you should fork first:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/runtime\u003c/code\u003e is the core ACK runtime and types\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e is the ACK code generator\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e contains the testing scripts\u003c/li\u003e\n\u003c/ul\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Prefix ACK forked repos with \u003ccode\u003eack-\u003c/code\u003e\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When I fork repositories to my personal Github account, I tend to prefix\nthe repositories with a common string for grouping purposes. For ACK source\nrepositories that I forked from the \u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github\nOrganization, I prefix those repositories with \u0026ldquo;ack-\u0026rdquo;. For example, when I\nforked the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e repository to my\n\u003ccode\u003egithub.com/jaypipes\u003c/code\u003e personal space on Github, I immediately renamed the\nforked repo to \u003ccode\u003egithub.com/jaypipes/ack-code-generator\u003c/code\u003e. This makes it easier\nto quickly filter repositories that are forked from the\n\u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e Github Organization.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eAfter forking the above common repositories, fork the upstream service\ncontroller repositories that you wish to work on or test out. The upstream\nservice controller repositories are in the \u003ccode\u003egithub.com/aws-controllers-k8s\u003c/code\u003e\nGithub Organization and follow a naming schema of \u003ccode\u003e$SERVICE_ALIAS-controller\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eSo, if you wanted to work on the S3 service controller, you would fork the\n\u003ccode\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/code\u003e source repository to your\npersonal Github space.\u003c/p\u003e\n\u003ch2 id="ensure-source-code-organization-directories-exist"\u003eEnsure source code organization directories exist\u003c/h2\u003e\n\u003cp\u003eMake sure in your \u003ccode\u003e$GOPATH/src\u003c/code\u003e that you have directories for the\n\u003ccode\u003eaws-controllers-k8s\u003c/code\u003e organization:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emkdir -p $GOPATH/src/github.com/aws-controllers-k8s\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Contributing to ACK core repositories\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you plan to make changes to one of the ACK core repositories e.g.,\n\u003ccode\u003ecode-generator \u003c/code\u003e, you might see errors in your IDE, such as \u003ccode\u003eUnresolved Type \u0026quot;Operation\u0026quot;\u003c/code\u003e. This is because some packages, like\n\u003ccode\u003egithub.com/aws/aws-sdk-go/private/model/api\u003c/code\u003e use Go build tags which some IDEs\ndo not enable by default. For Goland, build tag documentation can be found\n\u003ca href="https://www.jetbrains.com/help/go/configuring-build-constraints-and-vendoring.html#configure-build-constraints-for-your-project"\u003ehere\u003c/a\u003e.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="git-clone-forked-repositories-and-add-upstream-remote"\u003e\u003ccode\u003egit clone\u003c/code\u003e forked repositories and add upstream remote\u003c/h2\u003e\n\u003cp\u003eFor each of your forked repositories, you will \u003ccode\u003egit clone\u003c/code\u003e the repository into\nthe appropriate folder in your \u003ccode\u003e$GOPATH\u003c/code\u003e. Once \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d, you will want to\nset up a Git remote called \u0026ldquo;upstream\u0026rdquo; (remember that \u0026ldquo;origin\u0026rdquo; will be pointing\nat your forked repository location in your personal Github space).\u003c/p\u003e\n\u003cp\u003eYou can use this script to do this for you:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eGITHUB_ID=\u0026quot;your GH username\u0026quot;\n\n# Set this to \u0026quot;\u0026quot; if you did NOT take my advice above in the tip about prefixing\n# your personal forked ACK repository names with \u0026quot;ack-\u0026quot;\nACK_REPO_PREFIX=\u0026quot;ack-\u0026quot;\n\n# Clone all the common ACK repositories...\nCOMMON=\u0026quot;runtime code-generator test-infra\u0026quot;\nfor REPO in $COMMON; do\n cd $GOPATH/src/github.com/aws-controllers-k8s\n git clone git@github.com:$GITHUB_ID/$ACK_REPO_PREFIX$REPO $REPO\n cd $REPO\n git remote add upstream git@github.com:aws-controllers-k8s/$REPO\n git fetch --all\ndone\n\n# Now clone all the service controller repositories...\n# Change this to the list of services you forked service controllers for...\nSERVICES=\u0026quot;s3 sns ecr\u0026quot;\nfor SERVICE in $SERVICES; do\n cd $GOPATH/src/github.com/aws-controllers-k8s\n git clone git@github.com:$GITHUB_ID/$ACK_REPO_PREFIX$SERVICE-controller $SERVICE-controller\n cd $SERVICE-controller\n git remote add upstream git@github.com:aws-controllers-k8s/$SERVICE-controller\n git fetch --all\ndone\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-your-local-branch"\u003eCreate your local branch\u003c/h2\u003e\n\u003cp\u003eNext, you create a local branch where you work on your feature or bug fix.\nLet\u0026rsquo;s say you want to enhance the docs, so set \u003ccode\u003eBRANCH_NAME=docs-improve\u003c/code\u003e and\nthen:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit fetch --all \u0026amp;\u0026amp; git checkout -b $BRANCH_NAME upstream/main\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="commit-changes"\u003eCommit changes\u003c/h2\u003e\n\u003cp\u003eMake your changes locally, commit and push using:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit commit -a -m \u0026quot;improves the docs a lot\u0026quot;\n\ngit push origin $BRANCH_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWith an example output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eEnumerating objects: 6, done.\nCounting objects: 100% (6/6), done.\nDelta compression using up to 8 threads\nCompressing objects: 100% (4/4), done.\nWriting objects: 100% (4/4), 710 bytes | 710.00 KiB/s, done.\nTotal 4 (delta 2), reused 0 (delta 0)\nremote: Resolving deltas: 100% (2/2), completed with 2 local objects.\nremote: This repository moved. Please use the new location:\nremote: git@github.com:$GITHUB_ID/aws-controllers-k8s.git\nremote: \nremote: Create a pull request for \'docs\' on GitHub by visiting:\nremote: https://github.com/$GITHUB_ID/aws-controllers-k8s/pull/new/docs\nremote: \nTo github.com:a-hilaly/aws-controllers-k8s\n * [new branch] docs -\u0026gt; docs\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-a-pull-request"\u003eCreate a pull request\u003c/h2\u003e\n\u003cp\u003eFinally, submit a pull request against the upstream source repository.\u003c/p\u003e\n\u003cp\u003eUse either the link that show up as in the example above or to the upstream\nsource repository and there open the pull request as depicted below:\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/github-pr.png" alt="images"\u003e\u003c/p\u003e\n\u003cp\u003eWe monitor the GitHub repo and try to follow up with comments within a working\nday.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eAfter getting familiar with the various ACK source code repositories, now learn\n\u003ca href="../building-controller"\u003ehow to build an ACK service controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:18,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/autoscaling-example/",title:"Scale SageMaker Workloads with Application Auto Scaling",description:"Scale a SageMaker endpoint with the ACK Application Auto Scaling service controller",content:'\u003cp\u003eThe Application Auto Scaling ACK service controller makes it easier for developers to automatically scale resources for individual AWS services. Application Auto Scaling allows you to configure automatic scaling for resources such as Amazon SageMaker endpoint variants.\u003c/p\u003e\n\u003cp\u003eIn this tutorial, we will use the Application Auto Scaling ACK service controller in conjunction with the SageMaker ACK service controller to automatically scale a deployed machine learning model.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003cp\u003eThis guide also assumes that you have a trained machine learning model that you are ready to dynamically scale with the Application Auto Scaling ACK service controller. To train a machine learning model using the SageMaker ACK service controller, see \u003ca href="../sagemaker-example/"\u003eMachine Learning with the ACK Service Controller\u003c/a\u003e and return to this guide when you have successfully completed a SageMaker training job.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eA trained machine learning model that you want to scale dynamically.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq"\u003eyq\u003c/a\u003e - A command line tool for YAML processing. (For Linux environments, use the \u003ca href="https://mikefarah.gitbook.io/yq/#wget"\u003e\u003ccode\u003ewget\u003c/code\u003e plain binary installation\u003c/a\u003e)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://everything.curl.dev/get"\u003ecurl\u003c/a\u003e - A command line tool for transmitting data with URLs.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role and attach an IAM policy to that role to ensure that your Application Auto Scaling service controller has access to the appropriate AWS resources. First, check to make sure that you are connected to an Amazon EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport CLUSTER_NAME=\u0026lt;CLUSTER_NAME\u0026gt;\nexport SERVICE_REGION=\u0026lt;CLUSTER_REGION\u0026gt;\naws eks update-kubeconfig --name $CLUSTER_NAME --region $SERVICE_REGION\nkubectl config current-context\nkubectl get nodes\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBefore you can deploy your ACK service controllers using an IAM role, associate an OpenID Connect (OIDC) provider with your IAM role to authenticate your cluster with the IAM service.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eeksctl utils associate-iam-oidc-provider --cluster ${CLUSTER_NAME} \\\n--region ${SERVICE_REGION} --approve\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following OIDC information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport OIDC_PROVIDER_URL=$(aws eks describe-cluster --name $CLUSTER_NAME --region $SERVICE_REGION \\\n--query \u0026quot;cluster.identity.oidc.issuer\u0026quot; --output text | cut -c9-)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn your working directory, create a file named \u003ccode\u003etrust.json\u003c/code\u003e using the following trust relationship code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Federated\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':oidc-provider/\'$OIDC_PROVIDER_URL\'\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRoleWithWebIdentity\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;\'$OIDC_PROVIDER_URL\':aud\u0026quot;: \u0026quot;sts.amazonaws.com\u0026quot;,\n \u0026quot;\'$OIDC_PROVIDER_URL\':sub\u0026quot;: [\n \u0026quot;system:serviceaccount:ack-system:ack-sagemaker-controller\u0026quot;,\n \u0026quot;system:serviceaccount:ack-system:ack-applicationautoscaling-controller\u0026quot;\n ]\n }\n }\n }\n ]\n}\n\' \u0026gt; ./trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdating an Application Auto Scaling Scalable Target requires additional permissions. First, create a service-linked role for Application Auto Scaling.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-sh"\u003e aws iam create-service-linked-role --aws-service-name sagemaker.application-autoscaling.amazonaws.com\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a file named \u003ccode\u003epass_role_policy.json\u003c/code\u003e to create the policy required for the IAM role.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: \u0026quot;iam:PassRole\u0026quot;,\n \u0026quot;Resource\u0026quot;: \u0026quot;arn:aws:iam::\'$AWS_ACCOUNT_ID\':role/aws-service-role/sagemaker.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_SageMakerEndpoint\u0026quot;\n }\n ]\n}\n\' \u0026gt; ./pass_role_policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003eiam create-role\u003c/code\u003e command to create an IAM role with the trust relationship you just defined in \u003ccode\u003etrust.json\u003c/code\u003e. This IAM role enables the Amazon EKS cluster to get and refresh credentials from IAM.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport OIDC_ROLE_NAME=ack-controller-role-$CLUSTER_NAME\naws --region $SERVICE_REGION iam create-role --role-name $OIDC_ROLE_NAME --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the AmazonSageMakerFullAccess Policy to the IAM Role to ensure that your SageMaker service controller has access to the appropriate resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws --region $SERVICE_REGION iam attach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach the \u003ccode\u003eiam:PassRole\u003c/code\u003e policy required for updating an Application Auto Scaling Scalable Target.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam put-role-policy --role-name $OIDC_ROLE_NAME --policy-name \u0026quot;iam-pass-role-policy\u0026quot; --policy-document file://pass_role_policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the following IAM role information for future reference:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport IAM_ROLE_ARN_FOR_IRSA=$(aws --region $SERVICE_REGION iam get-role --role-name $OIDC_ROLE_NAME --output text --query \'Role.Arn\')\necho $IAM_ROLE_ARN_FOR_IRSA\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor more information on authorization and access for ACK service controllers, including details regarding recommended IAM policies, see \u003ca href="../../user-docs/authorization/"\u003eConfigure Permissions\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="install-the-application-auto-scaling-ack-service-controller"\u003eInstall the Application Auto Scaling ACK service controller\u003c/h3\u003e\n\u003cp\u003eGet the Application Auto Scaling Helm chart and make it available on the client machine with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport HELM_EXPERIMENTAL_OCI=1\nexport SERVICE=applicationautoscaling\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\n\nif [[ -z \u0026quot;$RELEASE_VERSION\u0026quot; ]]; then\n RELEASE_VERSION=1.0.2\nfi \n\nexport CHART_EXPORT_PATH=/tmp/chart\nexport CHART_REF=$SERVICE-chart\nexport CHART_REPO=public.ecr.aws/aws-controllers-k8s/$CHART_REF\nexport CHART_PACKAGE=$CHART_REF-$RELEASE_VERSION.tgz\n\nmkdir -p $CHART_EXPORT_PATH\n\nhelm pull oci://$CHART_REPO --version $RELEASE_VERSION -d $CHART_EXPORT_PATH\ntar xvf $CHART_EXPORT_PATH/$CHART_PACKAGE -C $CHART_EXPORT_PATH\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUpdate the Helm chart values for a cluster-scoped installation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Update the following values in the Helm chart\ncd $CHART_EXPORT_PATH/$SERVICE-chart\nyq e \'.aws.region = env(SERVICE_REGION)\' -i values.yaml\nyq e \'.serviceAccount.annotations.\u0026quot;eks.amazonaws.com/role-arn\u0026quot; = env(IAM_ROLE_ARN_FOR_IRSA)\' -i values.yaml\ncd -\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall the relevant custom resource definitions (CRDs) for the Application Auto Scaling ACK service controller.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate a namespace and install the Application Auto Scaling ACK service controller with the Helm chart.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_K8S_NAMESPACE=ack-system\nhelm install -n $ACK_K8S_NAMESPACE --create-namespace --skip-crds ack-$SERVICE-controller \\\n $CHART_EXPORT_PATH/$SERVICE-chart\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the CRDs and Helm charts were deployed with the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get pods -A | grep applicationautoscaling\nkubectl get crd | grep applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo scale a SageMaker endpoint variant with the Application Auto Scaling ACK service controller, you will also need the SageMaker ACK service controller. For step-by-step installation instructions see \u003ca href="../sagemaker-example/#install-the-sagemaker-ack-service-controller"\u003eInstall the SageMaker ACK Service Controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prepare-your-pretrained-model"\u003ePrepare your pretrained model\u003c/h3\u003e\n\u003cp\u003eTo scale a SageMaker endpoint with Application Auto Scaling, we first need a pretrained model in an S3 bucket. For this example, we will be using a pretrained XGBoost model.\u003c/p\u003e\n\u003cp\u003eFirst, create a variable for the S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport SAGEMAKER_BUCKET=ack-sagemaker-bucket-$ACCOUNT_ID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen, create a file named \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e with the following code block:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\n#!/usr/bin/env bash\n# Create the S3 bucket\nif [[ $SERVICE_REGION != \u0026quot;us-east-1\u0026quot; ]]; then\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot; --create-bucket-configuration LocationConstraint=\u0026quot;$SERVICE_REGION\u0026quot;\nelse\n aws s3api create-bucket --bucket \u0026quot;$SAGEMAKER_BUCKET\u0026quot; --region \u0026quot;$SERVICE_REGION\u0026quot;\nfi\' \u0026gt; ./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRun the \u003ccode\u003ecreate-bucket.sh\u003c/code\u003e script to create an S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003echmod +x create-bucket.sh\n./create-bucket.sh\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eGet the pretrained model and copy it into your S3 bucket.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ewget https://github.com/aws/amazon-sagemaker-examples/raw/af6667bd0be3c9cdec23fecda7f0be6d0e3fa3ea/sagemaker_model_monitor/introduction/model/xgb-churn-prediction-model.tar.gz\naws s3 cp xgb-churn-prediction-model.tar.gz s3://$SAGEMAKER_BUCKET\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="configure-permissions-for-your-sagemaker-endpoint"\u003eConfigure permissions for your SageMaker endpoint\u003c/h3\u003e\n\u003cp\u003eThe SageMaker endpoint that we deploy will need an IAM role to access Amazon S3 and Amazon SageMaker. Run the following commands to create a SageMaker execution IAM role that will be used by SageMaker to access the appropriate AWS resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SAGEMAKER_EXECUTION_ROLE_NAME=ack-sagemaker-execution-role-$ACCOUNT_ID\n\nTRUST=\u0026quot;{ \\\u0026quot;Version\\\u0026quot;: \\\u0026quot;2012-10-17\\\u0026quot;, \\\u0026quot;Statement\\\u0026quot;: [ { \\\u0026quot;Effect\\\u0026quot;: \\\u0026quot;Allow\\\u0026quot;, \\\u0026quot;Principal\\\u0026quot;: { \\\u0026quot;Service\\\u0026quot;: \\\u0026quot;sagemaker.amazonaws.com\\\u0026quot; }, \\\u0026quot;Action\\\u0026quot;: \\\u0026quot;sts:AssumeRole\\\u0026quot; } ] }\u0026quot;\naws iam create-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --assume-role-policy-document \u0026quot;$TRUST\u0026quot;\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam attach-role-policy --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\n\nSAGEMAKER_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name ${SAGEMAKER_EXECUTION_ROLE_NAME} --output text --query \'Role.Arn\')\n\necho $SAGEMAKER_EXECUTION_ROLE_ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="deploy-a-sagemaker-endpoint"\u003eDeploy a SageMaker endpoint\u003c/h2\u003e\n\u003cp\u003eUse the SageMaker ACK service controller to create a model, an endpoint configuration, and an endpoint.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport RANDOM_VAR=$RANDOM\nexport MODEL_NAME=ack-xgboost-model-$RANDOM_VAR\nexport ENDPOINT_CONFIG_NAME=ack-xgboost-endpoint-config-$RANDOM_VAR\nexport ENDPOINT_NAME=ack-xgboost-endpoint-$RANDOM_VAR\nexport XGBOOST_IMAGE=683313688378.dkr.ecr.us-east-1.amazonaws.com/sagemaker-xgboost:1.2-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Change XGBoost image URI based on region\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cstrong\u003eIMPORTANT\u003c/strong\u003e: If your \u003ccode\u003eSERVICE_REGION\u003c/code\u003e is not \u003ccode\u003eus-east-1\u003c/code\u003e, you must change the \u003ccode\u003eXGBOOST_IMAGE\u003c/code\u003e URI. To find your region-specific XGBoost image URI, choose your region in the \u003ca href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html"\u003eSageMaker Docker Registry Paths page\u003c/a\u003e, and then select \u003cstrong\u003eXGBoost (algorithm)\u003c/strong\u003e. For this example, use version 1.2-1.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eUse the following \u003ccode\u003edeploy.yaml\u003c/code\u003e file to deploy the model on an \u003ccode\u003eml.m5.large\u003c/code\u003e instance. To use your own model, change the \u003ccode\u003emodelDataURL\u003c/code\u003e value.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: Model\nmetadata:\n name: \'$MODEL_NAME\'\nspec:\n modelName: \'$MODEL_NAME\'\n primaryContainer:\n containerHostname: xgboost\n # The source of the model data\n modelDataURL: s3://\'$SAGEMAKER_BUCKET\'/xgb-churn-prediction-model.tar.gz\n image: \'$XGBOOST_IMAGE\'\n executionRoleARN: \'$SAGEMAKER_EXECUTION_ROLE_ARN\'\n---\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: EndpointConfig\nmetadata:\n name: \'$ENDPOINT_CONFIG_NAME\'\nspec:\n endpointConfigName: \'$ENDPOINT_CONFIG_NAME\'\n productionVariants:\n - modelName: \'$MODEL_NAME\'\n variantName: AllTraffic\n instanceType: ml.m5.large\n initialInstanceCount: 1\n---\napiVersion: sagemaker.services.k8s.aws/v1alpha1\nkind: Endpoint\nmetadata:\n name: \'$ENDPOINT_NAME\'\nspec:\n endpointName: \'$ENDPOINT_NAME\'\n endpointConfigName: \'$ENDPOINT_CONFIG_NAME\'\n\' \u0026gt; ./deploy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the endpoint by applying the \u003ccode\u003edeploy.yaml\u003c/code\u003e file.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f deploy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying the \u003ccode\u003edeploy.yaml\u003c/code\u003e file, you should see that the model, endpoint configuration, and endpoint were successfully created.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emodel.sagemaker.services.k8s.aws/ack-xgboost-model-7420 created\nendpointconfig.sagemaker.services.k8s.aws/ack-xgboost-endpoint-config-7420 created\nendpoint.sagemaker.services.k8s.aws/ack-xgboost-endpoint-7420 created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWatch the process with the \u003ccode\u003ekubectl get\u003c/code\u003e command. Deploying the endpoint may take some time.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get endpoints.sagemaker --watch\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe endpoint status will be \u003ccode\u003eInService\u003c/code\u003e when the endpoint is successfully deployed and ready for use.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME ENDPOINTSTATUS\nack-xgboost-endpoint-7420 Creating \nack-xgboost-endpoint-7420 InService \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="automatically-scale-your-sagemaker-endpoint"\u003eAutomatically scale your SageMaker endpoint\u003c/h2\u003e\n\u003cp\u003eScale your SageMaker endpoint using the Application Auto Scaling \u003ca href="https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalabletarget/"\u003e\u003ccode\u003eScalableTarget\u003c/code\u003e\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalingpolicy/"\u003e\u003ccode\u003eScalingPolicy\u003c/code\u003e\u003c/a\u003e resources.\u003c/p\u003e\n\u003ch3 id="create-a-scalable-target"\u003eCreate a scalable target\u003c/h3\u003e\n\u003cp\u003eCreate a scalable target with the \u003ccode\u003escalable-target.yaml\u003c/code\u003e file. The following file designates that a specified SageMaker endpoint variant can automatically scale to up to three instances.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: applicationautoscaling.services.k8s.aws/v1alpha1\nkind: ScalableTarget\nmetadata:\n name: ack-tutorial-endpoint-scalable-target\nspec:\n maxCapacity: 3\n minCapacity: 1\n resourceID: endpoint/\'$ENDPOINT_NAME\'/variant/AllTraffic\n scalableDimension: \u0026quot;sagemaker:variant:DesiredInstanceCount\u0026quot;\n serviceNamespace: sagemaker\n \' \u0026gt; ./scalable-target.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply your \u003ccode\u003escalable-target.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scalable-target.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your scalable target, you should see the following output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003escalabletarget.applicationautoscaling.services.k8s.aws/ack-tutorial-endpoint-scalable-target created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify that the \u003ccode\u003eScalableTarget\u003c/code\u003e was created with the \u003ccode\u003ekubectl describe\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe scalabletarget.applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-scaling-policy"\u003eCreate a scaling policy\u003c/h3\u003e\n\u003cp\u003eCreate a scaling policy with the \u003ccode\u003escaling-policy.yaml\u003c/code\u003e file. The following file creates a target tracking scaling policy that scales a specified SageMaker endpoint based on the number of variant invocations per instance. The scaling policy adds or removes capacity as required to keep this number close to the target value of 60.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eprintf \'\napiVersion: applicationautoscaling.services.k8s.aws/v1alpha1\nkind: ScalingPolicy\nmetadata:\n name: ack-tutorial-endpoint-scaling-policy\nspec:\n policyName: ack-tutorial-endpoint-scaling-policy\n policyType: TargetTrackingScaling\n resourceID: endpoint/\'$ENDPOINT_NAME\'/variant/AllTraffic\n scalableDimension: \u0026quot;sagemaker:variant:DesiredInstanceCount\u0026quot;\n serviceNamespace: sagemaker\n targetTrackingScalingPolicyConfiguration:\n targetValue: 60\n scaleInCooldown: 700\n scaleOutCooldown: 300\n predefinedMetricSpecification:\n predefinedMetricType: SageMakerVariantInvocationsPerInstance\n \' \u0026gt; ./scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply your \u003ccode\u003escaling-policy.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter applying your scaling policy, you should see the following output:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003escalingpolicy.applicationautoscaling.services.k8s.aws/ack-tutorial-endpoint-scaling-policy created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify that the \u003ccode\u003eScalingPolicy\u003c/code\u003e was created with the \u003ccode\u003ekubectl describe\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe scalingpolicy.applicationautoscaling\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eTo learn more about Application Auto Scaling on a SageMaker endpoint, see the \u003ca href="https://github.com/aws-controllers-k8s/applicationautoscaling-controller/tree/main/samples/hosting-autoscaling-on-sagemaker"\u003eApplication Auto Scaling controller samples\u003c/a\u003e repository.\u003c/p\u003e\n\u003ch3 id="updates"\u003eUpdates\u003c/h3\u003e\n\u003cp\u003eTo update the \u003ccode\u003eScalableTarget\u003c/code\u003e and \u003ccode\u003eScalingPolicy\u003c/code\u003e parameters after the resources are created, make any changes to the \u003ccode\u003escalable-target.yaml\u003c/code\u003e or \u003ccode\u003escaling-policy.yaml\u003c/code\u003e files and reapply them with \u003ccode\u003ekubectl apply\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl apply -f scalable-target.yaml\nkubectl apply -f scaling-policy.yaml.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your training jobs, endpoints, scalable targets, and scaling policies with the \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f deploy.yaml\nkubectl delete -f scalable-target.yaml\nkubectl delete -f scaling-policy.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SageMaker and Application Auto Scaling ACK service controllers, related CRDs, and namespaces see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eIt is recommended to delete any additional resources such as S3 buckets, IAM roles, and IAM policies when you no longer need them. You can delete these resources with the following commands or directly in the AWS console.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Delete S3 bucket\naws s3 rb s3://$SAGEMAKER_BUCKET --force\n\n# Delete SageMaker execution role\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam detach-role-policy --role-name $SAGEMAKER_EXECUTION_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonS3FullAccess\naws iam delete-role --role-name $SAGEMAKER_EXECUTION_ROLE_NAME\n\n# Delete IAM role created for IRSA\naws iam detach-role-policy --role-name $OIDC_ROLE_NAME --policy-arn arn:aws:iam::aws:policy/AmazonSageMakerFullAccess\naws iam delete-role --role-name $OIDC_ROLE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:19,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/rds-example/",title:"Deploy PostgreSQL, MySQL, MariaDB Instances Using the ACK RDS Controller",description:"Create managed PostgreSQL, MySQL, and MariaDB instances in Amazon Relational Database Service (RDS) from a Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eThe ACK service controller for Amazon Relational Database Service (RDS) lets you manage RDS database instances directly from Kubernetes. This includes the following database engines:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/aurora/"\u003eAmazon Aurora\u003c/a\u003e (MySQL \u0026amp; PostgreSQL)\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/postgresql/"\u003eAmazon RDS for PostgreSQL\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/mysql/"\u003eAmazon RDS for MySQL\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/mariadb/"\u003eAmazon RDS for MariaDB\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/oracle/"\u003eAmazon RDS for Oracle\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://aws.amazon.com/rds/sqlserver/"\u003eAmazon RDS for SQL Server\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThis guide will show you how to create and connect to several types of database engines available in \u003ca href="https://aws.amazon.com/rds/"\u003eAmazon RDS\u003c/a\u003e through Kubernetes.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.7+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-rds"\u003eInstall the ACK service controller for RDS\u003c/h3\u003e\n\u003cp\u003eYou can deploy the ACK service controller for Amazon RDS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/rds-chart"\u003erds-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now use the Helm chart to deploy the ACK service controller for Amazon RDS to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the RDS API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the RDS API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/rds-chart --version=0.0.27 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the RDS API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003erds\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="deploy-database-instances"\u003eDeploy Database Instances\u003c/h2\u003e\n\u003cp\u003eYou can deploy most RDS database instances using the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The examples below show how to deploy using different database engines in RDS from your Kubernetes environment. For a full list of options available in the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource definition, you can use \u003ccode\u003ekubectl explain dbinstance\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe examples below use the \u003ccode\u003edb.t4g.micro\u003c/code\u003e instance type. Please review the \u003ca href="https://aws.amazon.com/rds/instance-types/"\u003eRDS instance types\u003c/a\u003e to select the most appropriate one for your workload.\u003c/p\u003e\n\u003ch3 id="postgresql"\u003ePostgreSQL\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/postgresql/"\u003eAWS RDS for PostgreSQL\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for PostgreSQL 14 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-postgresql.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: postgres\n engineVersion: \u0026quot;14\u0026quot;\n masterUsername: \u0026quot;postgres\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-postgresql.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch3 id="mysql"\u003eMySQL\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/mysql/"\u003eAWS RDS for MySQL\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for MySQL 8.0 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-mysql.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: mysql\n engineVersion: \u0026quot;8.0\u0026quot;\n masterUsername: \u0026quot;admin\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-mysql.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eDBInstance\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch3 id="mariadb"\u003eMariaDB\u003c/h3\u003e\n\u003cp\u003eTo create a \u003ca href="https://aws.amazon.com/rds/mariadb/"\u003eAWS RDS for MariaDB\u003c/a\u003e instance, you must first set up a master password. You can do this by \u003ca href="https://kubernetes.io/docs/concepts/configuration/secret/#creating-a-secret"\u003ecreating a Kubernetes Secret\u003c/a\u003e, e.g.:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\nkubectl create secret generic \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot; \\\n --from-literal=password=\u0026quot;\u0026lt;your password\u0026gt;\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNext, create a \u003ccode\u003eDBInstance\u003c/code\u003e custom resource. The example below shows how to provision a RDS for MariaDB 10.6 instance with the credentials created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-mariadb.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.t4g.micro\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: mariadb\n engineVersion: \u0026quot;10.6\u0026quot;\n masterUsername: \u0026quot;admin\u0026quot;\n masterUserPassword:\n namespace: default\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-mariadb.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database by describing the DBInstance custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eDB Instance Status\u003c/code\u003e says \u003ccode\u003eAvailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch2 id="connect-to-database-instances"\u003eConnect to Database Instances\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eDBInstance\u003c/code\u003e status contains the information for connecting to a RDS database instance. The host information can be found in \u003ccode\u003estatus.endpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.endpoint.port\u003c/code\u003e. The master user name can be found in \u003ccode\u003espec.masterUsername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe database password is in the Secret that is referenced in the \u003ccode\u003eDBInstance\u003c/code\u003e spec (\u003ccode\u003espec.masterPassword.name\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. For example, to get the connection information from either RDS database instance created the above example, you can use the following example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_CONN_CM=\u0026quot;${RDS_INSTANCE_NAME}-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${RDS_INSTANCE_CONN_CM}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-host\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.address\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-port\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.port\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${RDS_INSTANCE_NAME}-user\nspec:\n to:\n name: ${RDS_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.spec.masterUsername\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${RDS_INSTANCE_NAME}\nEOF\n\nkubectl apply -f rds-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can inject these values into a container either as environmental variables or files. For example, here is a snippet of a Pod definition that will add the RDS instance connection info into the Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-pods.yaml\napiVersion: v1\nkind: Pod\nmetadata:\n name: app\n namespace: ${APP_NAMESPACE}\nspec:\n containers:\n - image: busybox\n name: myapp\n command:\n - sleep\n - \u0026quot;3600\u0026quot;\n imagePullPolicy: IfNotPresent\n env:\n - name: PGHOST\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-host\u0026quot;\n - name: PGPORT\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-port\u0026quot;\n - name: PGUSER\n valueFrom:\n configMapKeyRef:\n name: ${RDS_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${RDS_INSTANCE_NAME}-user\u0026quot;\n - name: PGPASSWORD\n valueFrom:\n secretKeyRef:\n name: \u0026quot;${RDS_INSTANCE_NAME}-password\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-pods.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-a-database-from-snapshot"\u003eCreate a Database from Snapshot\u003c/h2\u003e\n\u003cp\u003eYou can also restore a database snapshot to a specific \u003ccode\u003eDBInstance\u003c/code\u003e or \u003ccode\u003eDBCluster\u003c/code\u003e using the ACK for RDS controller.\u003c/p\u003e\n\u003cp\u003eTo restore a database snapshot to a \u003ccode\u003eDBInstance\u003c/code\u003e, you must set the \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e parameter. \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e should match the identifier of an existing DBSnapshot.\u003c/p\u003e\n\u003cp\u003eTo restore a database snapshot to a \u003ccode\u003eDBCluster\u003c/code\u003e, you must set the \u003ccode\u003eSnapshotIdentifier\u003c/code\u003e. The value of \u003ccode\u003eSnapshotIdentifier\u003c/code\u003e should match either an existing \u003ccode\u003eDBCluster\u003c/code\u003e snapshot identifier or an ARN of a \u003ccode\u003eDBInstance\u003c/code\u003esnapshot.\u003c/p\u003e\n\u003cp\u003eOnce it\u0026rsquo;s set and the resource is created, updating \u003ccode\u003eSnapshotIdentifer\u003c/code\u003e or \u003ccode\u003eDBSnapshotIdentifier\u003c/code\u003e fields will have no effect.\u003c/p\u003e\n\u003cp\u003eThe following examples show how you can restore database snapshots both to \u003ccode\u003eDBCluster\u003c/code\u003e and \u003ccode\u003eDBInstance\u003c/code\u003e resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_CLUSTER_NAME=\u0026quot;\u0026lt;your cluster name\u0026gt;\u0026quot;\nRDS_REGION=\u0026quot;\u0026lt;your aws region\u0026gt;\u0026quot;\nRDS_CUSTOMER_ACCOUNT=\u0026quot;\u0026lt;your aws account id\u0026gt;\u0026quot;\nRDS_DB_SNAPSHOT_IDENTIFIER=\u0026quot;\u0026lt;your db snapshot identifier\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-restore-dbcluster-snapshot.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBCluster\nmetadata:\n name: \u0026quot;${RDS_CLUSTER_NAME}\u0026quot;\nspec:\n dbClusterIdentifier: \u0026quot;${RDS_CLUSTER_NAME}\u0026quot;\n engine: aurora-postgresql\n engineVersion: \u0026quot;14\u0026quot;\n snapshotIdentifier: arn:aws:rds:${RDS_REGION}:${RDS_CUSTOMER_ACCOUNT}:snapshot:${RDS_DB_SNAPSHOT_IDENTIFIER}\nEOF\n\nkubectl apply -f rds-restore-dbcluster-snapshot.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eRDS_INSTANCE_NAME=\u0026quot;\u0026lt;your instance name\u0026gt;\u0026quot;\nRDS_DB_SNAPSHOT_IDENTIFIER=\u0026quot;\u0026lt;your db snapshot identifier\u0026gt;\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; rds-restore-dbinstance-snapshot.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\nspec:\n allocatedStorage: 20\n dbInstanceClass: db.m5.large\n dbInstanceIdentifier: \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n engine: postgres\n engineVersion: \u0026quot;14\u0026quot;\n masterUsername: \u0026quot;postgres\u0026quot;\n multiAZ: true\n dbSnapshotIdentifier: \u0026quot;${RDS_DB_SNAPSHOT_IDENTIFIER}\u0026quot;\nEOF\n\nkubectl apply -f rds-restore-dbinstance-snapshot.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eYou can learn more about each of the ACK service controller for RDS custom resources by using \u003ccode\u003ekubectl explain\u003c/code\u003e on the API resources. These include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbclusterparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbsecuritygroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eglobalclusters\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003edbproxy\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe ACK service controller for Amazon RDS is based on the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/"\u003eAmazon RDS API\u003c/a\u003e. To get a full understanding of how all of the APIs work, please review the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/"\u003eAmazon RDS API documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eYou can learn more about \u003ca href="https://docs.aws.amazon.com/rds/index.html"\u003ehow to use Amazon RDS\u003c/a\u003e through the \u003ca href="https://docs.aws.amazon.com/rds/index.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can deprovision your RDS instances using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete dbinstance \u0026quot;${RDS_INSTANCE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the RDS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:20,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/ec2-example/",title:"Manage a VPC Workflow with the ACK EC2-Controller",description:"Create and manage a network topology using ACK EC2-Controller deployed on Amazon Elastic Kubernetes Service (EKS) The ACK service controller for Elastic Compute Cloud (EC2-Controller) lets users manage EC2 resources directly from Kubernetes. This guide demonstrates how to deploy a basic network topology (consisting of VPC resources) using a single Kubernetes resource manifest.",content:'\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Registry (Amazon ECR) with ACK, this guide assumes that you have\naccess to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster and Amazon ECR repository, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e and \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/get-set-up-for-amazon-ecr.html"\u003eAmazon ECR Setup\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eHave access to Amazon ECR\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/engine/install/"\u003eDocker\u003c/a\u003e - A tool to build, share, and run containers.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-ack-ec2-controller"\u003eInstall ACK EC2-Controller\u003c/h3\u003e\n\u003cp\u003eDeploy the EC2-Controller using the Helm chart, \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/ec2-chart"\u003eec2-chart\u003c/a\u003e. Note, this example creates resources in the \u003ccode\u003eus-west-2\u003c/code\u003e region, but you can use any other region supported in AWS.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eInstall Helm chart:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=ec2\nexport AWS_REGION=\u0026lt;aws region id\u0026gt;\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/ec2-chart \u0026quot;--version=${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=${AWS_REGION}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the CRDs have been installed using \u003ccode\u003ekubectl get crds\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME CREATED AT\nadoptedresources.services.k8s.aws 2022-10-15T01:58:26Z\ndhcpoptions.ec2.services.k8s.aws 2022-10-15T01:58:26Z\nelasticipaddresses.ec2.services.k8s.aws 2022-10-15T01:58:26Z\neniconfigs.crd.k8s.amazonaws.com 2022-09-30T23:00:32Z\nfieldexports.services.k8s.aws 2022-10-15T01:58:26Z\ninstances.ec2.services.k8s.aws 2022-10-15T01:58:27Z\ninternetgateways.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nnatgateways.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nroutetables.ec2.services.k8s.aws 2022-10-15T01:58:27Z\nsecuritygrouppolicies.vpcresources.k8s.aws 2022-09-30T23:00:35Z\nsecuritygroups.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nsubnets.ec2.services.k8s.aws 2022-10-15T01:58:28Z\ntransitgateways.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nvpcendpoints.ec2.services.k8s.aws 2022-10-15T01:58:28Z\nvpcs.ec2.services.k8s.aws 2022-10-15T01:58:28Z\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values in the Helm chart, refer to \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/main/helm/values.yaml"\u003evalues.yaml\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eThe controller requires permissions to invoke EC2 APIs. Once the service controller is deployed \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e using the value \u003ccode\u003eSERVICE=ec2\u003c/code\u003e throughout. The recommended IAM Policy for EC2-Controller can be found in \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/main/config/iam/recommended-policy-arn"\u003erecommended-policy-arn\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="optional-create-a-vpc-and-subnet"\u003e[Optional] Create a VPC and Subnet\u003c/h3\u003e\n\u003cp\u003eThis section is optional and will NOT be using a single manifest file to deploy the VPC and Subnet. The purpose of this section is to demonstrate a simple use case to shed light on some of the functionality before jumping into a more complex deployment.\u003c/p\u003e\n\u003cp\u003eCreate the \u003cstrong\u003eVPC\u003c/strong\u003e using the provided YAML and \u003ccode\u003ekubectl apply\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; vpc.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: VPC\nmetadata:\n name: vpc-tutorial-test\nspec:\n cidrBlocks: \n - 10.0.0.0/16\n enableDNSSupport: true\n enableDNSHostnames: true\nEOF\n \nkubectl apply -f vpc.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the \u003cstrong\u003eVPC\u003c/strong\u003e \u003ccode\u003eStatus\u003c/code\u003e using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026gt; kubectl describe vpcs\n...\nStatus:\n Ack Resource Metadata:\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Cidr Block Association Set:\n Association ID: vpc-cidr-assoc-\u0026lt;ID\u0026gt;\n Cidr Block: 10.0.0.0/16\n Cidr Block State:\n State: associated\n Conditions:\n Last Transition Time: 2022-10-12T17:26:08Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Dhcp Options ID: dopt-\u0026lt;ID\u0026gt;\n Is Default: false\n Owner ID: \u0026lt;ID\u0026gt;\n State: available\n Vpc ID: vpc-\u0026lt;ID\u0026gt;\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003cstrong\u003eVPC\u003c/strong\u003e resource synced successfully and is available. Note the \u003ccode\u003evpc-\u0026lt;ID\u0026gt;\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eCreate the \u003cstrong\u003eSubnet\u003c/strong\u003e using \u003ccode\u003evpc-\u0026lt;ID\u0026gt;\u003c/code\u003e, the provided YAML, and \u003ccode\u003ekubectl apply\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; subnet.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: subnet-tutorial-test\nspec:\n cidrBlock: 10.0.0.0/20\n vpcID: vpc-\u0026lt;ID\u0026gt;\nEOF\n \nkubectl apply -f subnet.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the \u003cstrong\u003eSubnet\u003c/strong\u003e availability and ID using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026gt; kubectl describe subnets\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:ec2:us-west-2:\u0026lt;ID\u0026gt;:subnet/subnet-\u0026lt;ID\u0026gt;\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Available IP Address Count: 4091\n Conditions:\n Last Transition Time: 2022-10-12T17:36:53Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Default For AZ: false\n Map Customer Owned IP On Launch: false\n Owner ID: \u0026lt;ID\u0026gt;\n Private DNS Name Options On Launch:\n State: available\n Subnet ID: subnet-\u0026lt;ID\u0026gt;\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDelete the resources:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ekubectl delete -f subnet.yaml\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ekubectl delete -f vpc.yaml\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eBoth resources were successfully deployed, managed, then deleted by their respective controllers. Although contrived, this example highlights how easy it can be to deploy AWS resources via YAML files and how it feels like managing any other K8s resource.\u003c/p\u003e\n\u003cp\u003eIn this example, we used multiple YAML manifests and waited for the \u003ccode\u003evpcID\u003c/code\u003e to be generated before manually updating the Subnet custom resources to reference that VPC ID. This technique is less aligned to a fully declarative, GitOps-style of configuration management because dependencies between resources need to be manually resolved using a specific order of operations. The next example uses a single YAML manifest to deploy an entire network topology using ACK Resource References, a technique that better aligns with a fully automated and declarative GitOps-style of configuration management.\u003c/p\u003e\n\u003ch3 id="create-a-vpc-workflow"\u003eCreate a VPC Workflow\u003c/h3\u003e\n\u003cp\u003eIn this section, we create a network topology consisting of multiple, connected resources using a single YAML manifest. The following resources are present in this network topology:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e1 VPC\u003c/li\u003e\n\u003cli\u003e1 Instance\u003c/li\u003e\n\u003cli\u003e1 Internet Gateway\u003c/li\u003e\n\u003cli\u003e1 NAT Gateways\u003c/li\u003e\n\u003cli\u003e1 Elastic IPs\u003c/li\u003e\n\u003cli\u003e2 Route Tables\u003c/li\u003e\n\u003cli\u003e2 Subnets (1 Public; 1 Private)\u003c/li\u003e\n\u003cli\u003e1 Security Group\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003e\u003cimg src="../images/networktopology.png" alt="Network Topology"\u003e\u003c/p\u003e\n\u003cp\u003eThe VPC is connected to the Internet through an Internet Gateway. A NAT Gateway is created in the public Subnet with an associated Elastic IP. An Instance is deployed into the private Subnet which can connect to the Internet using the NAT Gateway in the public Subnet. Lastly, one Route Table (public) will contain a route to the Internet Gateway while the other Route Table (private) contains a route to the NAT Gateway.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNotice that the ACK custom resources reference each other using \u0026ldquo;*Ref\u0026rdquo; fields inside the manifest and the user does not have to worry about finding \u003ccode\u003evpc-ID\u003c/code\u003e when creating the Subnet resource manifests.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eEC2\u003c/em\u003e\nto find the supported reference fields.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNote, if the region used while installing the Helm chart is different from \u003ccode\u003eus-west-2\u003c/code\u003e, we need to modify availability zones and CIDR ranges in the provided YAML to match the needed region.\u003c/p\u003e\n\u003cp\u003eDeploy the resources using the provided YAML and \u003ccode\u003ekubectl apply -f vpc-workflow.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; vpc-workflow.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: VPC\nmetadata:\n name: tutorial-vpc\nspec:\n cidrBlocks: \n - 10.0.0.0/16\n enableDNSSupport: true\n enableDNSHostnames: true\n tags:\n - key: name\n value: vpc-tutorial\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: InternetGateway\nmetadata:\n name: tutorial-igw\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: NATGateway\nmetadata:\n name: tutorial-natgateway1\nspec:\n subnetRef:\n from:\n name: tutorial-public-subnet1\n allocationRef:\n from:\n name: tutorial-eip1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: ElasticIPAddress\nmetadata:\n name: tutorial-eip1\nspec:\n tags:\n - key: name\n value: eip-tutorial\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: RouteTable\nmetadata:\n name: tutorial-public-route-table\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n routes:\n - destinationCIDRBlock: 0.0.0.0/0\n gatewayRef:\n from:\n name: tutorial-igw\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: RouteTable\nmetadata:\n name: tutorial-private-route-table-az1\nspec:\n vpcRef:\n from:\n name: tutorial-vpc\n routes:\n - destinationCIDRBlock: 0.0.0.0/0\n natGatewayRef:\n from:\n name: tutorial-natgateway1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: tutorial-public-subnet1\nspec:\n availabilityZone: us-west-2a\n cidrBlock: 10.0.0.0/20\n mapPublicIPOnLaunch: true\n vpcRef:\n from:\n name: tutorial-vpc\n routeTableRefs:\n - from:\n name: tutorial-public-route-table\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Subnet\nmetadata:\n name: tutorial-private-subnet1\nspec:\n availabilityZone: us-west-2a\n cidrBlock: 10.0.128.0/20\n vpcRef:\n from:\n name: tutorial-vpc\n routeTableRefs:\n - from:\n name: tutorial-private-route-table-az1\n---\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: SecurityGroup\nmetadata:\n name: tutorial-security-group\nspec:\n description: \u0026quot;ack security group\u0026quot;\n name: tutorial-sg\n vpcRef:\n from:\n name: tutorial-vpc\n ingressRules:\n - ipProtocol: tcp\n fromPort: 22\n toPort: 22\n ipRanges:\n - cidrIP: \u0026quot;0.0.0.0/0\u0026quot;\n description: \u0026quot;ingress\u0026quot;\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output should look similar to:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003evpc.ec2.services.k8s.aws/tutorial-vpc created\ninternetgateway.ec2.services.k8s.aws/tutorial-igw created\nnatgateway.ec2.services.k8s.aws/tutorial-natgateway1 created\nelasticipaddress.ec2.services.k8s.aws/tutorial-eip1 created\nroutetable.ec2.services.k8s.aws/tutorial-public-route-table created\nroutetable.ec2.services.k8s.aws/tutorial-private-route-table-az1 created\nsubnet.ec2.services.k8s.aws/tutorial-public-subnet1 created\nsubnet.ec2.services.k8s.aws/tutorial-private-subnet1 created\nsecuritygroup.ec2.services.k8s.aws/tutorial-security-group created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCheck the resources you just created using \u003ccode\u003ekubectl describe\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ekubectl describe vpcs\nkubectl describe internetgateways\nkubectl describe routetables\nkubectl describe natgateways\nkubectl describe elasticipaddresses\nkubectl describe subnets\nkubectl describe securitygroups\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote that Subnet gets into an \u0026lsquo;available\u0026rsquo; state with a \u003ccode\u003eACK.ReferencesResolved = True\u003c/code\u003e condition attached notifying users that the references (VPC, RouteTable) have been found and resolved:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eStatus:\n Ack Resource Metadata:\n Arn: arn:aws:ec2:us-west-2:\u0026lt;ID\u0026gt;:subnet/subnet-0ba22f5820bb41584\n Owner Account ID: \u0026lt;ID\u0026gt;\n Region: us-west-2\n Available IP Address Count: 4091\n Conditions:\n Last Transition Time: 2022-10-13T14:54:39Z\n Status: True\n Type: ACK.ReferencesResolved\n Last Transition Time: 2022-10-13T14:54:41Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Default For AZ: false\n Map Customer Owned IP On Launch: false\n Owner ID: 515336597380\n Private DNS Name Options On Launch:\n State: available\n Subnet ID: subnet-\u0026lt;ID\u0026gt;\n \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="validate"\u003eValidate\u003c/h3\u003e\n\u003cp\u003eThis network setup should allow Instances deployed in the Private Subnet to connect to the Internet. To validate this behavior, deploy an Instance into the private Subnet and the public Subnet (bastion host). After waiting until the Instances are in an \u003ccode\u003eavailable\u003c/code\u003e state, \u003ccode\u003essh\u003c/code\u003e into the bastion host, then \u003ccode\u003essh\u003c/code\u003e into the private Subnet Instance, and test internet connectivity. A SecurityGroup is required by both instances launched in the public and private Subnets.\u003c/p\u003e\n\u003cp\u003eNote, we need to provide Subnet and SecurityGroup ID\u0026rsquo;s in the yaml manually; run \u003ccode\u003ekubectl describe subnets\u003c/code\u003e and \u003ccode\u003ekubectl describe securitygroups\u003c/code\u003e commands to get ID\u0026rsquo;s. We need to create key-pair via console and provide in yaml to launch instances.\u003c/p\u003e\n\u003cp\u003eDeploy an Instance into the Private Subnet using provided YAML and \u003ccode\u003ekubectl apply -f tutorial-instance-private.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; tutorial-instance-private.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Instance\nmetadata:\n name: tutorial-instance-private\nspec:\n imageID: ami-02b92c281a4d3dc79 # AL2; us-west-2\n instanceType: c3.large\n subnetID: subnet-\u0026lt;private-ID\u0026gt;\n securityGroupIDs:\n - sg-\u0026lt;ID\u0026gt;\n keyName: us-west-2-key # created via console\n tags:\n - key: producer\n value: ack\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the bastion host Instance into the Public Subnet using provided YAML and \u003ccode\u003ekubectl apply -f tutorial-bastion-host.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; tutorial-bastion-host.yaml\napiVersion: ec2.services.k8s.aws/v1alpha1\nkind: Instance\nmetadata:\n name: tutorial-bastion-host\nspec:\n imageID: ami-02b92c281a4d3dc79 # AL2 in us-west-2\n instanceType: c3.large\n subnetID: subnet-\u0026lt;public-ID\u0026gt;\n securityGroupIDs:\n - sg-\u0026lt;ID\u0026gt;\n keyName: us-west-2-key # created via console\n tags:\n - key: producer\n value: ack\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eValidate if the instances are created successfully with \u003ccode\u003ekubectl describe instances\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eIf you see following type of error in the output of above command, then find one of the available instance types for your Region and Availability zone and replace in the above YAML files\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eMessage: Unsupported: Your requested instance type (c3.large) is not supported in your requested Availability Zone (us-west-2a). Please retry your request by not specifying an Availability Zone or choosing us-west-2b, us-west-2c, us-west-2d, us-west-2e.\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can use below command to find EC2 instance types supported in your AWS region and availability zone (for example, to check if c5.large is supported in us-west-2 region and us-west-2a availability zone):\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eaws ec2 describe-instance-type-offerings --location-type \u0026quot;availability-zone\u0026quot; --filters Name=location,Values=us-west-2a --region us-west-2 --query \u0026quot;InstanceTypeOfferings[*].[InstanceType]\u0026quot; --output text | sort | grep c5.large\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFind out IDs of the instances in public and private subnets by running this command \u003ccode\u003ekubectl get instances\u003c/code\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME ID\ntutorial-instance-private *i-xxxxxxxxxxxxxxxx*\ntutorial-bastion-host *i-xxxxxxxxxxxxxxxx*\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote, we need to get \u003ccode\u003ePublic IPV4 DNS\u003c/code\u003e for bastion host instance from EC2 console and substitute in the below commands. We can get the \u003ccode\u003ePrivate IP\u003c/code\u003e for private instance on running \u003ccode\u003ekubectl describe instance tutorial-instance-private\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eDeployed 2 instances; one to each Subnet\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe instance in the public subnet will be the bastion host so we can ssh to the Instance in the private Subnet\n\u003cpre\u003e\u003ccode class="language-bash"\u003escp -i \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Public IPV4 DNS\u0026gt;:\nssh -i \u0026quot;/path/created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Public IPV4 DNS\u0026gt;\nssh -i \u0026quot;created_key_in_console_for_region.pem\u0026quot; ec2-user@\u0026lt;Private IP\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eValidate instance in private subnet can connect to internet\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eTry to ping websites from your private subnet, sample output looks like\n\u003cpre\u003e\u003ccode class="language-bash"\u003eping google.com\n\nPING google.com (142.250.217.78) 56(84) bytes of data.\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=1 ttl=102 time=8.30 ms\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=2 ttl=102 time=7.82 ms\n64 bytes from sea09s29-in-f14.1e100.net (142.250.217.78): icmp_seq=3 ttl=102 time=7.77 ms\n^C\n--- google.com ping statistics ---\n3 packets transmitted, 3 received, 0% packet loss, time 2003ms\n\u003c/code\u003e\u003c/pre\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resources using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f tutorial-bastion-host.yaml\nkubectl delete -f tutorial-instance-private.yaml\nkubectl delete -f vpc-workflow.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote, deleting resources can take a few minutes as we have couple of resources created using a single manifest, do not kill the \u003ccode\u003ekubectl delete\u003c/code\u003e command, wait until it finishes completely.\u003c/p\u003e\n\u003cp\u003eThe output of delete commands should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003einstance.ec2.services.k8s.aws \u0026quot;tutorial-bastion-host\u0026quot; deleted\ninstance.ec2.services.k8s.aws \u0026quot;tutorial-instance-private\u0026quot; deleted\nvpc.ec2.services.k8s.aws/tutorial-vpc deleted\ninternetgateway.ec2.services.k8s.aws/tutorial-igw deleted\nnatgateway.ec2.services.k8s.aws/tutorial-natgateway1 deleted\nelasticipaddress.ec2.services.k8s.aws/tutorial-eip1 deleted\nroutetable.ec2.services.k8s.aws/tutorial-public-route-table deleted\nroutetable.ec2.services.k8s.aws/tutorial-private-route-table-az1 deleted\nsubnet.ec2.services.k8s.aws/tutorial-public-subnet1 deleted\nsubnet.ec2.services.k8s.aws/tutorial-private-subnet1 deleted\nsecuritygroup.ec2.services.k8s.aws/tutorial-security-group deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the EC2 ACK service controller, related CRDs, and namespaces, see \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:21,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/apigatewayv2-reference-example/",title:"Manage HTTP APIs with the ACK APIGatewayv2 Controller",description:"Create and Invoke an Amazon APIGateway HTTP API using ACK APIGatewayv2 controller deployed on Amazon Elastic Kubernetes Service (EKS).",content:'\u003cp\u003eThe ACK service controller for Amazon APIGatewayv2 lets you manage HTTP APIs and VPC Links directly from Kubernetes.\nThis guide will show you how to create and invoke an HTTP API using a single Kubernetes resource manifest.\u003c/p\u003e\n\u003cp\u003eIn this tutorial we will invoke a single public endpoint by fronting it with an \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html"\u003eHTTP API\u003c/a\u003e. We create a\n\u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html"\u003eRoute\u003c/a\u003e with \u003ccode\u003eGET\u003c/code\u003e HTTP method and an \u003ccode\u003eHTTP_PROXY\u003c/code\u003e \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html"\u003eIntegration\u003c/a\u003e forwarding\ntraffic to the public endpoint. We also create an auto-deployable \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-stages.html"\u003eStage\u003c/a\u003e which will deploy the HTTP\nAPI and make it invokable.\u003c/p\u003e\n\u003cp\u003eTo invoke many endpoints using the single HTTP API, add multiple \u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-routes.html"\u003eRoutes\u003c/a\u003e and\n\u003ca href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations.html"\u003eIntegrations\u003c/a\u003e to the same API.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see\n\u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see\n\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-apigatewayv2"\u003eInstall the ACK service controller for APIGatewayv2\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon APIGatewayv2 using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/apigatewayv2-chart"\u003eapigatewayv2-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/apigatewayv2-chart --version=0.0.17 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to invoke the APIGatewayv2 API. For full details, please review the AWS Controllers for Kubernetes documentation\nfor \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the\nvalue of \u003ccode\u003eapigatewayv2\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-http-api"\u003eCreate HTTP API\u003c/h2\u003e\n\u003cp\u003eExecute the following command to create a manifest containing all the APIGatewayv2 custom resources and submit this\nmanifest to EKS cluster using kubectl.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eNotice that the ACK custom resources reference each other using \u0026ldquo;*Ref\u0026rdquo; fields inside the manifest and the user does not\nhave to worry about finding APIID, IntegrationID when creating the K8s resource manifests.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eAPIGatewayv2\u003c/em\u003e\nto find the supported reference fields.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAPI_NAME=\u0026quot;ack-api\u0026quot;\nINTEGRATION_NAME=\u0026quot;ack-integration\u0026quot;\nINTEGRATION_URI=\u0026quot;https://httpbin.org/get\u0026quot;\nROUTE_NAME=\u0026quot;ack-route\u0026quot;\nROUTE_KEY_NAME=\u0026quot;ack-route-key\u0026quot;\nSTAGE_NAME=\u0026quot;ack-stage\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; apigwv2-httpapi.yaml\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: API\nmetadata:\n name: \u0026quot;${API_NAME}\u0026quot;\nspec:\n name: \u0026quot;${API_NAME}\u0026quot;\n protocolType: HTTP\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Integration\nmetadata:\n name: \u0026quot;${INTEGRATION_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n integrationType: HTTP_PROXY\n integrationURI: \u0026quot;${INTEGRATION_URI}\u0026quot;\n integrationMethod: GET\n payloadFormatVersion: \u0026quot;1.0\u0026quot;\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Route\nmetadata:\n name: \u0026quot;${ROUTE_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n routeKey: \u0026quot;GET /${ROUTE_KEY_NAME}\u0026quot;\n targetRef:\n from:\n name: \u0026quot;${INTEGRATION_NAME}\u0026quot;\n\n---\n\napiVersion: apigatewayv2.services.k8s.aws/v1alpha1\nkind: Stage\nmetadata:\n name: \u0026quot;${STAGE_NAME}\u0026quot;\nspec:\n apiRef:\n from:\n name: \u0026quot;${API_NAME}\u0026quot;\n stageName: \u0026quot;${STAGE_NAME}\u0026quot;\n autoDeploy: true\n description: \u0026quot;auto deployed stage for ${API_NAME}\u0026quot;\nEOF\n\nkubectl apply -f apigwv2-httpapi.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe manifest contains 4 APIGatewayv2 custom resources: API, Integration, Route and Stage.\nWhen this manifest is submitted using \u003cem\u003ekubectl\u003c/em\u003e, it creates corresponding 4 custom resources in the EKS cluster.\u003c/p\u003e\n\u003cp\u003eThe output of above command looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eapi.apigatewayv2.services.k8s.aws/ack-api created\nintegration.apigatewayv2.services.k8s.aws/ack-integration created\nroute.apigatewayv2.services.k8s.aws/ack-route created\nstage.apigatewayv2.services.k8s.aws/ack-stage created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="describe-custom-resources"\u003eDescribe Custom Resources\u003c/h2\u003e\n\u003cp\u003eView these custom resources using following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe api/\u0026quot;${API_NAME}\u0026quot;\nkubectl describe integration/\u0026quot;${INTEGRATION_NAME}\u0026quot;\nkubectl describe route/\u0026quot;${ROUTE_NAME}\u0026quot;\nkubectl describe stage/\u0026quot;${STAGE_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eOutput of describing \u003cem\u003eRoute\u003c/em\u003e resource looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: ack-route\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: apigatewayv2.services.k8s.aws/v1alpha1\nKind: Route\nMetadata:\n Creation Timestamp: 2022-03-08T18:13:16Z\n Finalizers:\n finalizers.apigatewayv2.services.k8s.aws/Route\n Generation: 2\n Resource Version: 116729769\n UID: 0286a10e-0389-4ea8-90ae-890946d5d280\nSpec:\n API Key Required: false\n API Ref:\n From:\n Name: ack-api\n Authorization Type: NONE\n Route Key: GET /ack-route-key\n Target Ref:\n From:\n Name: ack-integration\nStatus:\n Ack Resource Metadata:\n Owner Account ID: ***********\n Conditions:\n Last Transition Time: 2022-03-08T18:13:23Z\n Status: True\n Type: ACK.ReferencesResolved\n Last Transition Time: 2022-03-08T18:13:23Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Route ID: *****\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Referencing Resources\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK controller reads the referenced resources and determines the identifiers, like APIID, from the referenced\nresources. Find the \u003cem\u003eACK.ReferencesResolved\u003c/em\u003e condition inside the \u003cem\u003eStatus\u003c/em\u003e of Route, Integration and Stage\nresources to see the progress of reference resolution.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="invoke-http-api"\u003eInvoke HTTP API\u003c/h2\u003e\n\u003cp\u003eExecute the following command to invoke the HTTP API\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecurl $(kubectl get api/\u0026quot;${API_NAME}\u0026quot; -o=jsonpath=\'{.status.apiEndpoint}\')/\u0026quot;${STAGE_NAME}\u0026quot;/\u0026quot;${ROUTE_KEY_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe above commands finds the invocation endpoint from the \u003cem\u003eApi\u003c/em\u003e custom resource and appends the required \u003cem\u003eStage\u003c/em\u003e name,\n\u003cem\u003eRoute Key\u003c/em\u003e to the url before invoking.\u003c/p\u003e\n\u003cp\u003eThe output should look similar to\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;args\u0026quot;: {},\n \u0026quot;headers\u0026quot;: {\n \u0026quot;Accept\u0026quot;: \u0026quot;*/*\u0026quot;,\n \u0026quot;Content-Length\u0026quot;: \u0026quot;0\u0026quot;,\n \u0026quot;Forwarded\u0026quot;: \u0026quot;by=****;for=****;host=******.execute-api.us-west-2.amazonaws.com;proto=https\u0026quot;,\n \u0026quot;Host\u0026quot;: \u0026quot;httpbin.org\u0026quot;,\n \u0026quot;User-Agent\u0026quot;: \u0026quot;curl/7.64.1\u0026quot;,\n \u0026quot;X-Amzn-Trace-Id\u0026quot;: \u0026quot;Self=****;Root=****\u0026quot;\n },\n \u0026quot;origin\u0026quot;: \u0026quot;****\u0026quot;,\n \u0026quot;url\u0026quot;: \u0026quot;https://httpbin.org/get\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon APIGatewayv2 is based on the \u003ca href="https://docs.aws.amazon.com/apigatewayv2/latest/api-reference/api-reference.html"\u003eAmazon APIGatewayv2 API\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eAPiGatewayv2\u003c/em\u003e to find\nall the supported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cul\u003e\n\u003cli\u003eCurrently ACK service controller for APIGatewayv2 only supports HTTP APIs.\u003c/li\u003e\n\u003cli\u003eWebSocket API support will be added in future releases.\u003c/li\u003e\n\u003cli\u003eSupport for DomainName and APIMapping will also be added in future releases.\u003c/li\u003e\n\u003c/ul\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f apigwv2-httpapi.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eapi.apigatewayv2.services.k8s.aws \u0026quot;ack-api\u0026quot; deleted\nintegration.apigatewayv2.services.k8s.aws \u0026quot;ack-integration\u0026quot; deleted\nroute.apigatewayv2.services.k8s.aws \u0026quot;ack-route\u0026quot; deleted\nstage.apigatewayv2.services.k8s.aws \u0026quot;ack-stage\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the APIGatewayv2 ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:22,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/memorydb-example/",title:"Create a managed Amazon MemoryDB for Redis Cluster using the ACK MemoryDB Controller",description:"Create a managed Amazon MemoryDB for Redis Cluster using the memorydb-controller",content:'\u003cp\u003eThe ACK service controller for Amazon MemoryDB for Redis lets you manage Amazon MemoryDB Cluster directly from Kubernetes.\nThis guide will show you how to create a \u003ca href="https://aws.amazon.com/memorydb/"\u003eAmazon MemoryDB for Redis\u003c/a\u003e Cluster using Kubernetes resource manifest.\u003c/p\u003e\n\u003cp\u003eIn this tutorial we will install ACK service controller for Amazon MemoryDB for Redis on an Amazon EKS Cluster. We configure IAM permissions for the controller to invoke Amazon MemoryDB API. We create Amazon MemoryDB Cluster instances. We also deploy a sample POD on the Amazon EKS Cluster to connect to the Amazon MemoryDB Cluster instance from the POD.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you have access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e. For automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS - \u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with Amazon EC2 Linux managed nodes. If you follow this document, install AWS CLI first. Use \u003ccode\u003eaws configure\u003c/code\u003e to access IAM permissions before creating EKS cluster.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.18 or higher.\u003c/li\u003e\n\u003cli\u003eSetup the \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html"\u003eAmazon VPC Container Network Interface (CNI) plugin for Kubernetes\u003c/a\u003e for the EKS Cluster.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-amazon-memorydb"\u003eInstall the ACK service controller for Amazon MemoryDB\u003c/h3\u003e\n\u003cp\u003eYou can deploy the ACK service controller for Amazon MemoryDB using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/memorydb-chart"\u003ememorydb-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can install the Helm chart to deploy the ACK service controller for Amazon MemoryDB to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the Amazon MemoryDB API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the Amazon MemoryDB API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/memorydb-chart --version=1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can find the latest version of ACK MemoryDB controller on GitHub \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/releases"\u003erelease page\u003c/a\u003e.\nReplace value for \u003ccode\u003e--version\u003c/code\u003e to the desired version.\u003c/p\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/memorydb-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the Amazon MemoryDB API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003ememorydb\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e. Install wget, \u003ca href="https://docs.openshift.com/container-platform/4.8/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli"\u003eoc\u003c/a\u003e, \u003ca href="https://github.com/stedolan/jq/wiki/Installation"\u003ejq\u003c/a\u003e, sed first. Skip Next Steps in the documentation.\u003c/p\u003e\n\u003ch2 id="create-amazon-memorydb-cluster-instances"\u003eCreate Amazon MemoryDB Cluster Instances\u003c/h2\u003e\n\u003cp\u003eYou can create Amazon MemoryDB Clusters using the \u003ccode\u003eCluster\u003c/code\u003e custom resource. The examples below show how to deploy it from your Kubernetes environment. For a full list of options available in the \u003ccode\u003eCluster\u003c/code\u003e custom resource definition, you can use \u003ccode\u003ekubectl explain cluster\u003c/code\u003e command.\u003c/p\u003e\n\u003ch3 id="amazon-memorydb-cluster"\u003eAmazon MemoryDB Cluster\u003c/h3\u003e\n\u003cp\u003eTo create a Amazon MemoryDB Cluster, create a \u003ccode\u003eCluster\u003c/code\u003e custom resource. The examples below shows how to provision a Amazon MemoryDB Cluster :\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eThe first example creates a Amazon MemoryDB Cluster in default VPC\u003c/li\u003e\n\u003cli\u003eThe second example creates a Amazon MemoryDB Cluster in specific VPC subnets and security groups.\nYou may choose any option from these examples. You can check more \u003ca href="https://github.com/aws-controllers-k8s/examples/tree/main/resources/memorydb/v1alpha1"\u003eyaml examples\u003c/a\u003e of all MemoryDB resources.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch4 id="create-amazon-memorydb-cluster-in-default-vpc"\u003eCreate Amazon MemoryDB Cluster in default VPC\u003c/h4\u003e\n\u003cp\u003eThe following YAML creates a MemoryDB Cluster using the default VPC subnets and security group.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-cluster.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: Cluster\nmetadata:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n nodeType: db.t4g.small\n aclName: open-access\nEOF\n\nkubectl apply -f memorydb-cluster.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-amazon-memorydb-cluster-in-specific-vpc-subnets-and-security-groups"\u003eCreate Amazon MemoryDB Cluster in specific VPC subnets and security groups\u003c/h4\u003e\n\u003cp\u003eTo create a Amazon MemoryDB Cluster using specific subnets from a VPC, create a MemoryDB \u003ccode\u003eSubnectGroup\u003c/code\u003e custom resource first and then specify it, and a security group name, in the \u003ccode\u003eCluster\u003c/code\u003e specification.\u003c/p\u003e\n\u003ch5 id="create-amazon-memorydb-subnet-group"\u003eCreate Amazon MemoryDB subnet group\u003c/h5\u003e\n\u003cp\u003eThe following example uses the VPC ID of the EKS Cluster. You may specify any other VPC ID by updating the \u003ccode\u003eVPC_ID\u003c/code\u003e variable in the following example.\nReplace \u003ccode\u003eEKS_CLUSTER_NAME\u003c/code\u003e to the eks cluster name you created under \u0026lsquo;Prerequisites\u0026rsquo; section.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eEKS_CLUSTER_NAME=\u0026quot;example-eks-cluster\u0026quot;\nAWS_REGION=\u0026quot;us-east-1\u0026quot;\nVPC_ID=$(aws --region $AWS_REGION eks describe-cluster --name $EKS_CLUSTER_NAME --query cluster.resourcesVpcConfig.vpcId)\nSUBNET_IDS=$(aws --region $AWS_REGION ec2 describe-subnets \\\n --filters \u0026quot;Name=vpc-id,Values=${VPC_ID}\u0026quot; \\\n --query \'Subnets[*].SubnetId\' \\\n --output text\n)\n\nMEMORYDB_SUBNETGROUP_NAME=\u0026quot;example-subnet-group\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-subnetgroup.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: SubnetGroup\nmetadata:\n name: \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\n description: \u0026quot;MemoryDB cluster subnet group\u0026quot;\n subnetIDs:\n$(printf \u0026quot; - %s\\n\u0026quot; ${SUBNET_IDS})\n\nEOF\n\nkubectl apply -f memorydb-subnetgroup.yaml\nkubectl describe subnetgroup \u0026quot;${MEMORYDB_SUBNETGROUP_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf you observe that the \u003ccode\u003eACK.Terminal\u003c/code\u003e condition is set for the SubnetGroup and the error is similar to the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eStatus:\n Conditions:\n Message: SubnetNotAllowedFault: Subnets: [subnet-1d111111, subnet-27d22222] are not in a supported availability zone. Supported availability zones are [us-east-1c, us-east-1d, us-east-1b].\n Status: True\n Type: ACK.Terminal\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThen update the \u003ccode\u003esubnetIDs\u003c/code\u003e in the input YAML and provide the subnet Ids that are in a supported availability zone.\u003c/p\u003e\n\u003ch5 id="create-amazon-memorydb-cluster"\u003eCreate Amazon MemoryDB Cluster\u003c/h5\u003e\n\u003cp\u003eThe following example uses the MemoryDB subnet group created above. It uses the provisioning EKS Cluster\u0026rsquo;s security group. You may specify any other VPC security group by modifying the list of \u003ccode\u003esecurityGroupIDs\u003c/code\u003e in the specification.\nIt uses the \u003ccode\u003edb.t4g.small\u003c/code\u003e node type for the MemoryDB cluster. Please review the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.supportedtypes.html"\u003eMemoryDB node types\u003c/a\u003e to select the most appropriate one for your workload.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eEKS_CLUSTER_NAME=\u0026quot;example-eks-cluster\u0026quot;\nMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\nAWS_REGION=\u0026quot;us-east-1\u0026quot;\nSECURITY_GROUP_ID=$(aws --region $AWS_REGION eks describe-cluster --name $EKS_CLUSTER_NAME --query cluster.resourcesVpcConfig.clusterSecurityGroupId)\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-cluster.yaml\napiVersion: memorydb.services.k8s.aws/v1alpha1\nkind: Cluster\nmetadata:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\nspec:\n name: \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n nodeType: db.t4g.small\n aclName: open-access\n securityGroupIDs:\n - ${SECURITY_GROUP_ID}\n subnetGroupName: ${MEMORYDB_SUBNETGROUP_NAME}\nEOF\n\nkubectl apply -f memorydb-cluster.yaml\nkubectl describe cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can track the status of the provisioned database using \u003ccode\u003ekubectl describe\u003c/code\u003e on the \u003ccode\u003eCluster\u003c/code\u003e custom resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of the \u003cem\u003eCluster\u003c/em\u003e resource looks like:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: clusters\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: memorydb.services.k8s.aws/last-requested-node-type: db.t4g.medium\n memorydb.services.k8s.aws/last-requested-num-shards: 2\nAPI Version: memorydb.services.k8s.aws/v1alpha1\nKind: Cluster\nMetadata:\n Creation Timestamp: 2022-03-30T08:47:07Z\n Finalizers:\n finalizers.memorydb.services.k8s.aws/Cluster\n Generation: 5\n Resource Version: 158132376\n Self Link: /apis/memorydb.services.k8s.aws/v1alpha1/namespaces/default/clusters/clusters\n UID: 2f6fc7ed-fe04-42cb-85bf-b7982dedec1c\nSpec:\n Acl Name: open-access\n Auto Minor Version Upgrade: true\n Engine Version: 6.2\n Maintenance Window: sat:03:00-sat:04:00\n Name: clusters\n Node Type: db.t4g.medium\n Num Replicas Per Shard: 1\n Num Shards: 2\n Parameter Group Name: default.memorydb-redis6\n Snapshot Retention Limit: 0\n Snapshot Window: 05:30-06:30\n Subnet Group Name: default\n Tls Enabled: true\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:memorydb:us-east-1:************:cluster/clusters\n Owner Account ID: ************\n Allowed Scale Down Node Types:\n db.t4g.small\n Allowed Scale Up Node Types:\n db.r6g.12xlarge\n db.r6g.16xlarge\n db.r6g.2xlarge\n db.r6g.4xlarge\n db.r6g.8xlarge\n db.r6g.large\n db.r6g.xlarge\n Cluster Endpoint:\n Address: clustercfg.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Conditions:\n Last Transition Time: 2022-04-06T22:05:25Z\n Message: Resource synced successfully\n Reason:\n Status: True\n Type: ACK.ResourceSynced\n Engine Patch Version: 6.2.4\n Number Of Shards: 2\n Parameter Group Status: in-sync\n Shards:\n Name: 0001\n Nodes:\n Availability Zone: us-east-1d\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0001-001.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0001-001\n Status: available\n Availability Zone: us-east-1b\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0001-002.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0001-002\n Status: available\n Number Of Nodes: 2\n Slots: 0-8191\n Status: available\n Name: 0002\n Nodes:\n Availability Zone: us-east-1c\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0002-001.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0002-001\n Status: available\n Availability Zone: us-east-1d\n Create Time: 2022-03-30T09:04:04Z\n Endpoint:\n Address: clusters-0002-002.clusters.******.memorydb.us-east-1.amazonaws.com\n Port: 6379\n Name: clusters-0002-002\n Status: available\n Number Of Nodes: 2\n Slots: 8192-16383\n Status: available\n Status: available\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen the \u003ccode\u003eCluster Status\u003c/code\u003e says \u003ccode\u003eavailable\u003c/code\u003e, you can connect to the database instance.\u003c/p\u003e\n\u003ch2 id="connect-to-amazon-memorydb-cluster"\u003eConnect to Amazon MemoryDB Cluster\u003c/h2\u003e\n\u003cblockquote\u003e\n\u003cp\u003eTo connect to the MemoryDB Cluster from a Pod running inside Kubernetes cluster:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eEnsure that the \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/managing-vpc-cni.html"\u003eAmazon VPC Container Network Interface (CNI) plugin for Kubernetes\u003c/a\u003e has been setup for the EKS Cluster.\u003c/li\u003e\n\u003cli\u003eReview \u003ca href="https://docs.aws.amazon.com/memorydb/latest/devguide/memorydb-vpc-accessing.html"\u003eaccess patterns for accessing a MemoryDB Cluster in an Amazon VPC\u003c/a\u003e to confirm that MemoryDB cluster is configured to allow connection from the Pod.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eThe \u003ccode\u003eCluster\u003c/code\u003e status contains the information for connecting to a Amazon MemoryDB for Redis Cluster. The host information can be found in \u003ccode\u003estatus.clusterEndpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.clusterEndpoint.port\u003c/code\u003e. For example, you can get the connection information for a \u003ccode\u003eCluster\u003c/code\u003e created in one of the previous examples using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl get cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot; -o jsonpath=\'{.status.clusterEndpoint.address}\'\nkubectl get cluster \u0026quot;${MEMORYDB_CLUSTER_NAME}\u0026quot; -o jsonpath=\'{.status.clusterEndpoint.port}\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. The following example makes the MemoryDB cluster endpoint and port available as ConfigMap data:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eMEMORYDB_CLUSTER_NAME=\u0026quot;example-memorydb-cluster\u0026quot;\nMEMORYDB_CLUSTER_CONN_CM=\u0026quot;${MEMORYDB_CLUSTER_NAME}-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; memorydb-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${MEMORYDB_CLUSTER_NAME}-host\nspec:\n to:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.clusterEndpoint.address\u0026quot;\n resource:\n group: memorydb.services.k8s.aws\n kind: Cluster\n name: ${MEMORYDB_CLUSTER_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${MEMORYDB_CLUSTER_NAME}-port\nspec:\n to:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.clusterEndpoint.port\u0026quot;\n resource:\n group: memorydb.services.k8s.aws\n kind: Cluster\n name: ${MEMORYDB_CLUSTER_NAME}\nEOF\n\nkubectl apply -f memorydb-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eConfirm that the Amazon MemoryDB endpoint details are available in the config map by running the following command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ekubectl get configmap/${MEMORYDB_CLUSTER_CONN_CM} -o jsonpath=\'{.data}\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThese values can be injected into a container either as environmental variables or files. For example, here is a snippet of a deployment definition that will add the Amazon MemoryDB Cluster connection info into a Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; game_leaderboard.yaml\napiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: leaderboard-deployment\n labels:\n app: leaderboard\nspec:\n replicas: 1\n selector:\n matchLabels:\n app: leaderboard\n template:\n metadata:\n labels:\n app: leaderboard\n spec:\n containers:\n - name: leaderboard\n image: public.ecr.aws/sam/build-python3.8:latest\n tty: true\n stdin: true\n env:\n - name: MEMORYDB_CLUSTER_HOST\n valueFrom:\n configMapKeyRef:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n key: \u0026quot;${MEMORYDB_CLUSTER_NAME}-host\u0026quot;\n - name: MEMORYDB_CLUSTER_PORT\n valueFrom:\n configMapKeyRef:\n name: ${MEMORYDB_CLUSTER_CONN_CM}\n key: \u0026quot;${MEMORYDB_CLUSTER_NAME}-port\u0026quot;\nEOF\n\nkubectl apply -f game_leaderboard.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eConfirm that the leaderboard application container has been deployed successfully by running the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003ekubectl get pods –selector=app=leaderboard\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify that the Pod Status is \u003ccode\u003eRunning\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eGet a shell to the running leaderboard container.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eLEADERBOARD_POD_NAME=$(kubectl get pods –selector=app=leaderboard -o jsonpath=\'{.items[*].metadata.name}\')\nkubectl exec –stdin –tty ${LEADERBOARD_POD_NAME} -- /bin/bash\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the running leaderboard container shell, run the following commands and confirm that the MemoryDB cluster host and port are available as environment variables.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003e# Confirm that the memorydb cluster host, port are available as environment variables\necho $MEMORYDB_CLUSTER_HOST\necho $MEMORYDB_CLUSTER_PORT\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eYou can learn more about each of the ACK service controller for Amazon MemoryDB custom resources by using \u003ccode\u003ekubectl explain\u003c/code\u003e on the API resources. These include:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eacl\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eparametergroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esubnetgroup\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe ACK service controller for Amazon MemoryDB is based on the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/APIReference/Welcome.html"\u003eAmazon MemoryDB API\u003c/a\u003e. To get a full understanding of how all the APIs work, please review the \u003ca href="https://docs.aws.amazon.com/memorydb/latest/APIReference/Welcome.html"\u003eAmazon MemoryDB API documentation\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eYou can learn more about \u003ca href="https://docs.aws.amazon.com/memorydb/index.html"\u003ehow to use Amazon MemoryDB\u003c/a\u003e through the \u003ca href="https://docs.aws.amazon.com/memorydb/index.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can deprovision your Amazon MemoryDB for Redis Cluster using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cp\u003eFollowing commands delete the resources that were created in this tutorial.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f game_leaderboard.yaml\nkubectl delete -f memorydb-field-exports.yaml\nkubectl delete -f memorydb-cluster.yaml\nkubectl delete -f memorydb-subnetgroup.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the MemoryDB ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:23,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/aurora-serverless-v2/",title:"Manage an Aurora Serverless v2 cluster with the ACK RDS Controller",description:"Create an Aurora Serverless v2 cluster from an Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eAurora Serverless v2 introduces the ability to automatically and instantly scale\ndatabase capacity for Aurora MySQL-compatiable and Aurora PostgreSQL-compatible\nclusters. Scaling uses fine-grained increments called Aurora capacity units\n(ACUs) that incrementally scale up and down over smaller units (e.g. 0.5, 1,\n1.5, 2) instead of doubling on each scaling operation (e.g. 16 =\u0026gt; 32).\nAurora Serverless v2 helps applications with variable workloads or multitenancy\nto only use the resources they need and manage costs, instead of having to\nprovision for a peak workload.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage\n\u003ca href="https://aws.amazon.com/rds/aurora/serverless/"\u003eAurora Serverless v2\u003c/a\u003e instances\nfrom an Amazon Elastic Kubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eThis tutorial uses \u003ca href="https://www.eksworkshop.com/010_introduction/"\u003eAmazon EKS Workshop\u003c/a\u003e to deploy EKS cluster.\u003c/p\u003e\n\u003ch3 id="set-up-amazon-eks-workshop"\u003eSet up Amazon EKS Workshop\u003c/h3\u003e\n\u003col\u003e\n\u003cli\u003eCreate a \u003ca href="https://www.eksworkshop.com/020_prerequisites/workspace/"\u003eworkspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eInstall the \u003ca href="https://www.eksworkshop.com/020_prerequisites/k8stools/"\u003eKubernetes tools\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eCreate an \u003ca href="https://www.eksworkshop.com/020_prerequisites/iamrole/"\u003eIAM role for workspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eAttach \u003ca href="https://www.eksworkshop.com/020_prerequisites/ec2instance/"\u003eIAM role to workspace\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eUpdate \u003ca href="https://www.eksworkshop.com/020_prerequisites/workspaceiam/"\u003eIAM settings\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://www.eksworkshop.com/020_prerequisites/kmskey/"\u003eCreate KMS customer managed keys\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch3 id="deploy-an-amazon-eks-cluster"\u003eDeploy an Amazon EKS cluster\u003c/h3\u003e\n\u003col start="2"\u003e\n\u003cli\u003eInstall \u003ca href="https://www.eksworkshop.com/030_eksctl/prerequisites/"\u003eeksctl tools\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eInstall \u003ca href="https://www.eksworkshop.com/beginner/060_helm/helm_intro/install/"\u003eHelm\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eLaunch an \u003ca href="https://www.eksworkshop.com/030_eksctl/launcheks/"\u003eEKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003eTest \u003ca href="https://www.eksworkshop.com/030_eksctl/test/"\u003eEKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e(Optional) \u003ca href="https://www.eksworkshop.com/030_eksctl/console/#:~:text=The%20EKS%20console%20allows%20you,granted%20permission%20within%20the%20cluster."\u003eGrant console access to EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="install-ack-service-controller-for-rds"\u003eInstall ACK service controller for RDS\u003c/h2\u003e\n\u003cp\u003eTo manage an Aurora Serverless v2 cluster from Kubernetes / Amazon EKS, you will need to install the ACK for RDS service controller. You can deploy the ACK service controller for Amazon RDS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/rds-chart"\u003erds-chart Helm chart\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eDefine environment variables\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eSERVICE=rds\nRELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nACK_SYSTEM_NAMESPACE=ack-system\nAWS_REGION=\u0026lt;ADD-REGION-HERE\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | \\\n helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now use the Helm chart to deploy the ACK service controller for Amazon RDS to your EKS cluster. At a minimum, you need to specify the AWS Region to execute the RDS API calls.\u003c/p\u003e\n\u003cp\u003eFor example, to specify that the RDS API calls go to the \u003ccode\u003eus-east-1\u003c/code\u003e region, you can deploy the service controller with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n \u0026quot;${ACK_SYSTEM_NAMESPACE}\u0026quot; \u0026quot;oci://public.ecr.aws/aws-controllers-k8s/${SERVICE}-chart\u0026quot; --version=\u0026quot;${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=\u0026quot;${AWS_REGION}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the controller to query the RDS API. For full details, please review the AWS Controllers for Kubernetes documentation for \u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value of \u003ccode\u003erds\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-aurora-serverless-v2-postgresql-database"\u003eCreate an Aurora Serverless v2 PostgreSQL database\u003c/h2\u003e\n\u003cp\u003eTo create an Aurora Serverless v2 database using the PostgreSQL engine, you must\nfirst create a DBSubnetGroup and a SecurityGroup for the VPC:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAPP_NAMESPACE=mydb\nkubectl create ns \u0026quot;${APP_NAMESPACE}\u0026quot;\n\nEKS_VPC_ID=$(aws eks describe-cluster --name \u0026quot;${EKS_CLUSTER_NAME}\u0026quot; --query \u0026quot;cluster.resourcesVpcConfig.vpcId\u0026quot; --output text)\n\nRDS_SUBNET_GROUP_NAME=\u0026quot;my-subnet-group\u0026quot;\nRDS_SUBNET_GROUP_DESCRIPTION=\u0026quot;database subnet group\u0026quot;\nEKS_SUBNET_IDS=$(aws ec2 describe-subnets --filter \u0026quot;Name=vpc-id,Values=${EKS_VPC_ID}\u0026quot; --query \'Subnets[?MapPublicIpOnLaunch==`false`].SubnetId\' --output text)\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; db-subnet-groups.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBSubnetGroup\nmetadata:\n name: ${RDS_SUBNET_GROUP_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n name: ${RDS_SUBNET_GROUP_NAME}\n description: ${RDS_SUBNET_GROUP_DESCRIPTION}\n subnetIDs:\n$(printf \u0026quot; - %s\\n\u0026quot; ${EKS_SUBNET_IDS})\n tags: []\nEOF\n\nkubectl apply -f db-subnet-groups.yaml\n\nRDS_SECURITY_GROUP_NAME=\u0026quot;ack-security-group\u0026quot;\nRDS_SECURITY_GROUP_DESCRIPTION=\u0026quot;ACK security group\u0026quot;\n\nEKS_CIDR_RANGE=$(aws ec2 describe-vpcs \\\n --vpc-ids \u0026quot;${EKS_VPC_ID}\u0026quot; \\\n --query \u0026quot;Vpcs[].CidrBlock\u0026quot; \\\n --output text\n)\n\nRDS_SECURITY_GROUP_ID=$(aws ec2 create-security-group \\\n --group-name \u0026quot;${RDS_SECURITY_GROUP_NAME}\u0026quot; \\\n --description \u0026quot;${RDS_SECURITY_GROUP_DESCRIPTION}\u0026quot; \\\n --vpc-id \u0026quot;${EKS_VPC_ID}\u0026quot; \\\n --output text\n)\naws ec2 authorize-security-group-ingress \\\n --group-id \u0026quot;${RDS_SECURITY_GROUP_ID}\u0026quot; \\\n --protocol tcp \\\n --port 5432 \\\n --cidr \u0026quot;${EKS_CIDR_RANGE}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSet up a master password using a Kubernetes Secret. Set \u003ccode\u003eRDS_DB_USERNAME\u003c/code\u003e and \u003ccode\u003eRDS_DB_PASSWORD\u003c/code\u003e to your preferred values for your RDS credentials:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e\nRDS_DB_USERNAME=\u0026quot;adminer\u0026quot;\nRDS_DB_PASSWORD=\u0026quot;password\u0026quot;\n\nkubectl create secret generic -n \u0026quot;${APP_NAMESPACE}\u0026quot; ack-creds \\\n --from-literal=username=\u0026quot;${RDS_DB_USERNAME}\u0026quot; \\\n --from-literal=password=\u0026quot;${RDS_DB_PASSWORD}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can now create an Aurora Serverless v2 cluster for both the PostgreSQL and\nMySQL database engines. The example below uses the PostgreSQL engine. For example, to use\nMySQL, set \u003ccode\u003eENGINE_TYPE\u003c/code\u003e to \u003ccode\u003eaurora-mysql\u003c/code\u003e and \u003ccode\u003eENGINE_VERSION\u003c/code\u003e to \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.versions"\u003eminimum supported version\u003c/a\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport AURORA_DB_CLUSTER_NAME=\u0026quot;ack-db\u0026quot;\nexport AURORA_DB_INSTANCE_NAME=\u0026quot;ack-db-instance01\u0026quot;\nexport AURORA_DB_INSTANCE_CLASS=\u0026quot;db.serverless\u0026quot;\nexport MAX_ACU=64\nexport MIN_ACU=4\n\nexport ENGINE_TYPE=aurora-postgresql\nexport ENGINE_VERSION=13\n\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; asv2-db-cluster.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBCluster\nmetadata:\n name: ${AURORA_DB_CLUSTER_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n backupRetentionPeriod: 7\n serverlessV2ScalingConfiguration:\n maxCapacity: ${MAX_ACU}\n minCapacity: ${MIN_ACU}\n dbClusterIdentifier: ${AURORA_DB_CLUSTER_NAME}\n dbSubnetGroupName: ${RDS_SUBNET_GROUP_NAME}\n engine: ${ENGINE_TYPE}\n engineVersion: \u0026quot;${ENGINE_VERSION}\u0026quot;\n masterUsername: adminer\n masterUserPassword:\n namespace: ${APP_NAMESPACE}\n name: ack-creds\n key: password\n vpcSecurityGroupIDs:\n - ${RDS_SECURITY_GROUP_ID}\nEOF\n\nkubectl apply -f asv2-db-cluster.yaml\n\n\ncat \u0026lt;\u0026lt;-EOF \u0026gt; asv2-db-instance.yaml\napiVersion: rds.services.k8s.aws/v1alpha1\nkind: DBInstance\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}\n namespace: ${APP_NAMESPACE}\nspec:\n dbInstanceClass: ${AURORA_DB_INSTANCE_CLASS}\n dbInstanceIdentifier: ${AURORA_DB_INSTANCE_NAME}\n dbClusterIdentifier: ${AURORA_DB_CLUSTER_NAME}\n dbSubnetGroupName: ${RDS_SUBNET_GROUP_NAME}\n engine: ${ENGINE_TYPE}\n engineVersion: \u0026quot;${ENGINE_VERSION}\u0026quot;\n publiclyAccessible: false\nEOF\n\nkubectl apply -f asv2-db-instance.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Required \u003ccode\u003eserverlessV2ScalingConfiguration\u003c/code\u003e attributes\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n In the \u003ccode\u003eDBCluster\u003c/code\u003e custom resource, you \u003cstrong\u003emust\u003c/strong\u003e set both the \u003ccode\u003eminCapacity\u003c/code\u003e and\n\u003ccode\u003emaxCapacity\u003c/code\u003e attributes in the \u003ccode\u003eserverlessV2ScalingConfiguration\u003c/code\u003e section,\notherwise the database cluster will not be created.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eTo see your newly created Aurora Serverless v2 cluster, you can run the\nfollowing command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe -n \u0026quot;${APP_NAMESPACE}\u0026quot; \u0026quot;dbclusters/${AURORA_DB_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="connect-to-database-instances"\u003eConnect to Database Instances\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eDBInstance\u003c/code\u003e status contains the information for connecting to a RDS database instance. The host information can be found in \u003ccode\u003estatus.endpoint.address\u003c/code\u003e and the port information can be found in \u003ccode\u003estatus.endpoint.port\u003c/code\u003e. The master user name can be found in \u003ccode\u003espec.masterUsername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThe database password is in the Secret that is referenced in the \u003ccode\u003eDBInstance\u003c/code\u003e spec (\u003ccode\u003espec.masterPassword.name\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eYou can extract this information and make it available to your Pods using a \u003ca href="../../user-docs/field-export"\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e resource. For example, to get the connection information from either RDS database instance created the above example, you can use the following example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAURORA_INSTANCE_CONN_CM=\u0026quot;asv2-db-instance-conn-cm\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; asv2-db-field-exports.yaml\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ${AURORA_INSTANCE_CONN_CM}\n namespace: ${APP_NAMESPACE}\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-host\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.address\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-port\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.status.endpoint.port\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: ${AURORA_DB_INSTANCE_NAME}-user\n namespace: ${APP_NAMESPACE}\nspec:\n to:\n name: ${AURORA_INSTANCE_CONN_CM}\n kind: configmap\n from:\n path: \u0026quot;.spec.masterUsername\u0026quot;\n resource:\n group: rds.services.k8s.aws\n kind: DBInstance\n name: ${AURORA_DB_INSTANCE_NAME}\nEOF\n\nkubectl apply -f asv2-db-field-exports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can inject these values into a container either as environmental variables or files. For example, here is a snippet of a Pod definition that will add the RDS instance connection info into the Pod:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rds-pods.yaml\napiVersion: v1\nkind: Pod\nmetadata:\n name: app\n namespace: ${APP_NAMESPACE}\nspec:\n containers:\n - image: busybox\n name: myapp\n command:\n - sleep\n - \u0026quot;3600\u0026quot;\n imagePullPolicy: IfNotPresent\n env:\n - name: PGHOST\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-host\u0026quot;\n - name: PGPORT\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-port\u0026quot;\n - name: PGUSER\n valueFrom:\n configMapKeyRef:\n name: ${AURORA_INSTANCE_CONN_CM}\n key: \u0026quot;${APP_NAMESPACE}.${AURORA_DB_INSTANCE_NAME}-user\u0026quot;\n - name: PGPASSWORD\n valueFrom:\n secretKeyRef:\n name: \u0026quot;ack-creds\u0026quot;\n key: password\nEOF\n\nkubectl apply -f rds-pods.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="cleanup"\u003eCleanup\u003c/h2\u003e\n\u003cp\u003eYou can delete your Aurora Serverless v2 cluster using the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f asv2-db-instance.yaml\nkubectl delete -f asv2-db-cluster.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the RDS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:24,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/eventbridge-example/",title:"Manage EventBridge event buses and rules with the ACK EventBridge Controller",description:"Send filtered events on a custom bus to SQS.",content:'\u003cp\u003eEventBridge is a serverless service that uses events to connect application components together, making it easier for\nyou to build scalable event-driven applications. Use it to route events from sources such as home-grown applications,\nAWS services, and third-party software to consumer applications across your organization. EventBridge provides a simple\nand consistent way to ingest, filter, transform, and deliver events so you can build new applications quickly.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage a custom EventBridge \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html"\u003eevent\nbus\u003c/a\u003e and\n\u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rules.html"\u003erule\u003c/a\u003e to filter and forward messages to an SQS\n\u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html"\u003etarget\u003c/a\u003e from an Amazon Elastic Kubernetes\n(EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to manages queues and send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://stedolan.github.io/jq/download/"\u003ejq\u003c/a\u003e to parse AWS CLI JSON output\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-eventbridge"\u003eInstall the ACK service controller for EventBridge\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon EventBridge using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/eventbridge-chart"\u003eeventbridge-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/eventbridge-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/eventbridge-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the EventBridge API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003eeventbridge\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-eventbridge-custom-event-bus-and-rule-with-an-sqs-target"\u003eCreate an EventBridge Custom Event Bus and Rule with an SQS Target\u003c/h2\u003e\n\u003ch3 id="create-the-target-sqs-queue"\u003eCreate the target SQS queue\u003c/h3\u003e\n\u003cp\u003eTo keep the scope of this tutorial simple, the SQS queue and IAM permissions will be created with the AWS CLI.\nAlternatively, the \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-sqs"\u003eACK SQS\nController\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-iam"\u003eACK IAM\nController\u003c/a\u003e can be used to manage\nthese resources with Kubernetes.\u003c/p\u003e\n\u003cp\u003eExecute the following command to define the environment variables used throughout the example.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport EVENTBRIDGE_NAMESPACE=eventbridge-example\nexport EVENTBUS_NAME=custom-eventbus-ack\nexport RULE_NAME=custom-eventbus-ack-sqs-rule\nexport TARGET_QUEUE=custom-eventbus-ack-rule-sqs-target\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate the target queue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; target-queue.json\n{\n \u0026quot;QueueName\u0026quot;: \u0026quot;${TARGET_QUEUE}\u0026quot;,\n \u0026quot;Attributes\u0026quot;: {\n \u0026quot;Policy\u0026quot;: \u0026quot;{\\\u0026quot;Statement\\\u0026quot;:[{\\\u0026quot;Sid\\\u0026quot;:\\\u0026quot;EventBridgeToSqs\\\u0026quot;,\\\u0026quot;Effect\\\u0026quot;:\\\u0026quot;Allow\\\u0026quot;,\\\u0026quot;Principal\\\u0026quot;:{\\\u0026quot;Service\\\u0026quot;:\\\u0026quot;events.amazonaws.com\\\u0026quot;},\\\u0026quot;Action\\\u0026quot;:[\\\u0026quot;sqs:SendMessage\\\u0026quot;],\\\u0026quot;Resource\\\u0026quot;:\\\u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${TARGET_QUEUE}\\\u0026quot;,\\\u0026quot;Condition\\\u0026quot;:{\\\u0026quot;ArnEquals\\\u0026quot;:{\\\u0026quot;aws:SourceArn\\\u0026quot;:\\\u0026quot;arn:aws:events:${AWS_REGION}:${AWS_ACCOUNT_ID}:rule/${EVENTBUS_NAME}/${RULE_NAME}\\\u0026quot;}}}]}\u0026quot;\n }\n}\nEOF\n\naws sqs create-queue --cli-input-json file://target-queue.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/custom-eventbus-ack-rule-sqs-target\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-custom-event-bus"\u003eCreate a Custom Event Bus\u003c/h3\u003e\n\u003cp\u003eExecute the following command to create the example namespace and a custom event bus.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create ns ${EVENTBRIDGE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; bus.yaml\napiVersion: eventbridge.services.k8s.aws/v1alpha1\nkind: EventBus\nmetadata:\n name: ${EVENTBUS_NAME}\nspec:\n name: ${EVENTBUS_NAME}\nEOF\n\nkubectl -n ${EVENTBRIDGE_NAMESPACE} create -f bus.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003enamespace/eventbridge-example created\neventbus.eventbridge.services.k8s.aws/custom-eventbus-ack created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the event bus resource is synchronized.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} get eventbus ${EVENTBUS_NAME}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SYNCED AGE\ncustom-eventbus-ack True 64s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-a-rule-with-an-sqs-target"\u003eCreate a Rule with an SQS Target\u003c/h3\u003e\n\u003cp\u003eExecute the following command to retrieve the ARN for the SQS target created above needed for the Kubernetes manifest.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport TARGET_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eExecute the following command to create a Kubernetes manifest for a rule, forwarding events matching the specified rule\nfilter criteria to the target queue. The EventBridge filter pattern will match any event received on the custom event\nbus with a \u003ccode\u003edetail-type\u003c/code\u003e of \u003ccode\u003eevent.from.ack.v0\u003c/code\u003e. Alternatively, the filter pattern can be omitted to forward all events\nfrom the custom event bus.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; rule.yaml\napiVersion: eventbridge.services.k8s.aws/v1alpha1\nkind: Rule\nmetadata:\n name: $RULE_NAME\nspec:\n name: $RULE_NAME\n description: \u0026quot;ACK EventBridge Filter Rule to SQS using event bus reference\u0026quot;\n eventBusRef:\n from:\n name: $EVENTBUS_NAME\n eventPattern: |\n {\n \u0026quot;detail-type\u0026quot;:[\u0026quot;event.from.ack.v0\u0026quot;]\n }\n targets:\n - arn: $TARGET_QUEUE_ARN\n id: sqs-rule-target\n retryPolicy:\n maximumRetryAttempts: 0 # no retries\nEOF\n\nkubectl -n ${EVENTBRIDGE_NAMESPACE} create -f rule.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003erule.eventbridge.services.k8s.aws/custom-eventbus-ack-sqs-rule created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the rule resource is synchronized.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} get rule ${RULE_NAME}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME SYNCED AGE\ncustom-eventbus-ack-sqs-rule True 18s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="verify-the-event-filtering-and-forwarding-is-working"\u003eVerify the event filtering and forwarding is working\u003c/h3\u003e\n\u003cp\u003eExecute the following command to send an event to the custom bus matching the rule filter pattern.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; event.json\n[\n {\n \u0026quot;Source\u0026quot;: \u0026quot;my.aws.events.cli\u0026quot;,\n \u0026quot;DetailType\u0026quot;: \u0026quot;event.from.ack.v0\u0026quot;,\n \u0026quot;Detail\u0026quot;: \u0026quot;{\\\u0026quot;hello-world\\\u0026quot;:\\\u0026quot;from ACK for EventBridge\\\u0026quot;}\u0026quot;,\n \u0026quot;EventBusName\u0026quot;: \u0026quot;${EVENTBUS_NAME}\u0026quot;\n }\n]\nEOF\n\naws events put-events --entries file://event.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;FailedEntryCount\u0026quot;: 0,\n \u0026quot;Entries\u0026quot;: [\n {\n \u0026quot;EventId\u0026quot;: \u0026quot;ccd21ee8-339d-cabe-520d-b847c98ba2cb\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was received by the SQS queue with\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026quot;MessageId\u0026quot;: \u0026quot;80cef2f3-ff25-4441-9217-665bb0217ec5\u0026quot;,\n \u0026lt;snip\u0026gt;\n \u0026quot;Body\u0026quot;: \u0026quot;{\\\u0026quot;version\\\u0026quot;:\\\u0026quot;0\\\u0026quot;,\\\u0026quot;id\\\u0026quot;:\\\u0026quot;def3d99b-806b-5d92-d036-9e0884bdc387\\\u0026quot;,\\\u0026quot;detail-type\\\u0026quot;:\\\u0026quot;event.from.ack.v0\\\u0026quot;,\\\u0026quot;source\\\u0026quot;:\\\u0026quot;my.aws.events.cli\\\u0026quot;,\\\u0026quot;account\\\u0026quot;:\\\u0026quot;1234567890\\\u0026quot;,\\\u0026quot;time\\\u0026quot;:\\\u0026quot;2023-03-22T11:22:34Z\\\u0026quot;,\\\u0026quot;region\\\u0026quot;:\\\u0026quot;us-east-1\\\u0026quot;,\\\u0026quot;resources\\\u0026quot;:[],\\\u0026quot;detail\\\u0026quot;:{\\\u0026quot;hello-world\\\u0026quot;:\\\u0026quot;from ACK for EventBridge\\\u0026quot;}}\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon EventBridge is based on the \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/Welcome.html"\u003eAmazon EventBridge\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eEventBridge\u003c/em\u003e to find all the\nsupported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${EVENTBRIDGE_NAMESPACE} delete -f rule.yaml\nkubectl -n ${EVENTBRIDGE_NAMESPACE} delete -f bus.yaml\nkubectl delete ns ${EVENTBRIDGE_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003erule.eventbridge.services.k8s.aws \u0026quot;custom-eventbus-ack-sqs-rule\u0026quot; deleted\neventbus.eventbridge.services.k8s.aws \u0026quot;custom-eventbus-ack\u0026quot; deleted\nnamespace \u0026quot;eventbridge-example\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eRemove the manually created SQS resource.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eTo remove the EventBridge ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:25,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/pipes-example/",title:"Manage EventBridge Pipes with the ACK Pipes Controller",description:"Forward messages between two SQS queues with a pipe.",content:'\u003cp\u003eAmazon EventBridge Pipes connects sources to targets. It reduces the need for specialized knowledge and integration code\nwhen developing event driven architectures, fostering consistency across your company’s applications. To set up a pipe,\nyou choose the source, add optional filtering, define optional enrichment, and choose the target for the event data.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage an \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html"\u003eEventBridge\nPipe\u003c/a\u003e to forward messages between two SQS queues\nfrom an Amazon Elastic Kubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to manages queues and send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://stedolan.github.io/jq/download/"\u003ejq\u003c/a\u003e to parse AWS CLI JSON output\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-pipes"\u003eInstall the ACK service controller for Pipes\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon Pipes using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/pipes-chart"\u003epipes-chart Helm chart\u003c/a\u003e. Resources should be created in the \u003ccode\u003eus-east-1\u003c/code\u003e region:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/pipes-chart --version=v1.0.0 --generate-name --set=aws.region=us-east-1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/pipes-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the Pipes API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003epipes\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-eventbridge-pipe"\u003eCreate an EventBridge Pipe\u003c/h2\u003e\n\u003ch3 id="create-the-source-and-target-sqs-queues"\u003eCreate the source and target SQS queues\u003c/h3\u003e\n\u003cp\u003eTo keep the scope of this tutorial simple, the SQS queues and IAM permissions will be created with the AWS CLI.\nAlternatively, the \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-sqs"\u003eACK SQS\nController\u003c/a\u003e and \u003ca href="https://aws-controllers-k8s.github.io/community/docs/community/services/#amazon-iam"\u003eACK IAM\nController\u003c/a\u003e can be used to manage\nthese resources with Kubernetes.\u003c/p\u003e\n\u003cp\u003eExecute the following command to define the environment variables used throughout the example.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport PIPE_NAME=pipes-sqs-to-sqs\nexport PIPE_NAMESPACE=pipes-example\nexport SOURCE_QUEUE=pipes-sqs-source\nexport TARGET_QUEUE=pipes-sqs-target\nexport PIPE_ROLE=pipes-sqs-to-sqs-role\nexport PIPE_POLICY=pipes-sqs-to-sqs-policy\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCreate the source and target queues.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs create-queue --queue-name ${SOURCE_QUEUE}\naws sqs create-queue --queue-name ${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/pipes-sqs-source\u0026quot;\n}\n{\n \u0026quot;QueueUrl\u0026quot;: \u0026quot;https://sqs.us-east-1.amazonaws.com/1234567890/pipes-sqs-target\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-the-pipes-iam-role"\u003eCreate the Pipes IAM Role\u003c/h3\u003e\n\u003cp\u003eCreate an IAM role for the pipe to consume messages from the source queue and send messages to the target queue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; trust.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;pipes.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;aws:SourceAccount\u0026quot;: \u0026quot;${AWS_ACCOUNT_ID}\u0026quot;\n }\n }\n }\n ]\n}\nEOF\n\naws iam create-role --role-name ${PIPE_ROLE} --assume-role-policy-document file://trust.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Role\u0026quot;: {\n \u0026quot;Path\u0026quot;: \u0026quot;/\u0026quot;,\n \u0026quot;RoleName\u0026quot;: \u0026quot;pipes-sqs-to-sqs-role\u0026quot;,\n \u0026quot;RoleId\u0026quot;: \u0026quot;ABCDU3F4JDBEUCMGT3XBH\u0026quot;,\n \u0026quot;Arn\u0026quot;: \u0026quot;arn:aws:iam::1234567890:role/pipes-sqs-to-sqs-role\u0026quot;,\n \u0026quot;CreateDate\u0026quot;: \u0026quot;2023-03-21T13:11:59+00:00\u0026quot;,\n \u0026quot;AssumeRolePolicyDocument\u0026quot;: {\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;pipes.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;,\n \u0026quot;Condition\u0026quot;: {\n \u0026quot;StringEquals\u0026quot;: {\n \u0026quot;aws:SourceAccount\u0026quot;: \u0026quot;1234567890\u0026quot;\n }\n }\n }\n ]\n }\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAttach a policy to the role to give the pipe permissions to read and send messages.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; policy.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sqs:ReceiveMessage\u0026quot;,\n \u0026quot;sqs:DeleteMessage\u0026quot;,\n \u0026quot;sqs:GetQueueAttributes\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${SOURCE_QUEUE}\u0026quot;\n ]\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;sqs:SendMessage\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${TARGET_QUEUE}\u0026quot;\n ]\n }\n ]\n}\nEOF\n\naws iam put-role-policy --role-name ${PIPE_ROLE} --policy-name ${PIPE_POLICY} --policy-document file://policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003ch3 id="create-the-pipe"\u003eCreate the Pipe\u003c/h3\u003e\n\u003cp\u003eExecute the following command to retrieve the ARNs for the resources created above needed for the Kubernetes manifest.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SOURCE_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\nexport TARGET_QUEUE_ARN=$(aws --output json sqs get-queue-attributes --queue-url \u0026quot;https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\u0026quot; --attribute-names QueueArn | jq -r \'.Attributes.QueueArn\')\nexport PIPE_ROLE_ARN=$(aws --output json iam get-role --role-name ${PIPE_ROLE} | jq -r \'.Role.Arn\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eExecute the following command to create a Kubernetes manifest for a pipe consuming messages from the source queue and\nsending messages matching the filter criteria to the target queue using the above created IAM role.\u003c/p\u003e\n\u003cp\u003eThe EventBridge filter pattern will match any SQS message from the source queue with a JSON-stringified body\n\u003ccode\u003e{\\\u0026quot;from\\\u0026quot;:\\\u0026quot;kubernetes\\\u0026quot;}\u003c/code\u003e. Alternatively, the filter pattern can be omitted to forward all messages from the source\nqueue.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create ns ${PIPE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; pipe-sqs-to-sqs.yaml\napiVersion: pipes.services.k8s.aws/v1alpha1\nkind: Pipe\nmetadata:\n name: $PIPE_NAME\nspec:\n name: $PIPE_NAME\n source: $SOURCE_QUEUE_ARN\n description: \u0026quot;SQS to SQS Pipe with filtering\u0026quot;\n sourceParameters:\n filterCriteria:\n filters:\n - pattern: \u0026quot;{\\\u0026quot;body\\\u0026quot;:{\\\u0026quot;from\\\u0026quot;:[\\\u0026quot;kubernetes\\\u0026quot;]}}\u0026quot;\n sqsQueueParameters:\n batchSize: 1\n maximumBatchingWindowInSeconds: 1\n target: $TARGET_QUEUE_ARN\n roleARN: $PIPE_ROLE_ARN\nEOF\n\nkubectl -n ${PIPE_NAMESPACE} create -f pipe-sqs-to-sqs.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003enamespace/pipes-example created\npipe.pipes.services.k8s.aws/pipes-sqs-to-sqs created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="describe-pipe-custom-resource"\u003eDescribe Pipe Custom Resource\u003c/h3\u003e\n\u003cp\u003eView the Pipe custom resource to verify it is in a \u003ccode\u003eRUNNING\u003c/code\u003e state.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n $PIPE_NAMESPACE get pipe $PIPE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eNAME STATE SYNCED AGE\npipes-sqs-to-sqs RUNNING True 3m10s\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="verify-the-pipe-filtering-and-forwarding-is-working"\u003eVerify the Pipe filtering and forwarding is working\u003c/h3\u003e\n\u003cp\u003eExecute the following command to send a message to the source queue with a body matching the pipe filter pattern.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs send-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE} --message-body \u0026quot;{\\\u0026quot;from\\\u0026quot;:\\\u0026quot;kubernetes\\\u0026quot;}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;MD5OfMessageBody\u0026quot;: \u0026quot;fde2da607356f1974691e48fa6a87157\u0026quot;,\n \u0026quot;MessageId\u0026quot;: \u0026quot;f4157187-0308-420c-b69b-aa439e6be7e3\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was consumed by the pipe, the filter pattern matched and the message was received by the target queue\nwith\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Receive Delays\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It might take some time for the Pipe to consume the message from the source and deliver it to the target queue.\nIf the above command does not return a message, rerun the command a couple of times with some delay in between the requests.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026lt;snip\u0026gt;\n \u0026quot;MD5OfBody\u0026quot;: \u0026quot;d5255184c571cca2c78e76d6eea1745d\u0026quot;,\n \u0026quot;Body\u0026quot;: \u0026quot;{\\\u0026quot;messageId\\\u0026quot;:\\\u0026quot;f4157187-0308-420c-b69b-aa439e6be7e3\\\u0026quot;,\n \u0026lt;snip\u0026gt;\n \\\u0026quot;body\\\u0026quot;:\\\u0026quot;{\\\\\\\u0026quot;from\\\\\\\u0026quot;:\\\\\\\u0026quot;kubernetes\\\\\\\u0026quot;}\\\u0026quot;,\\\u0026quot;attributes\\\u0026quot;:{\\\u0026quot;ApproximateReceiveCount\\\u0026quot;:\\\u0026quot;1\\\u0026quot;,\n \u0026lt;snip\u0026gt;\n \\\u0026quot;eventSourceARN\\\u0026quot;:\\\u0026quot;arn:aws:sqs:us-east-1:1234567890:pipes-sqs-source\\\u0026quot;,\\\u0026quot;awsRegion\\\u0026quot;:\\\u0026quot;us-east-1\\\u0026quot;}\u0026quot;\n }\n ]\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon EventBridge Pipes is based on the \u003ca href="https://docs.aws.amazon.com/eventbridge/latest/pipes-reference/Welcome.html"\u003eAmazon EventBridge Pipes\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003ePipes\u003c/em\u003e to find all the\nsupported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the Pipes resources created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${PIPE_NAMESPACE} delete -f pipe-sqs-to-sqs.yaml\nkubectl delete ns ${PIPE_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003epipe.pipes.services.k8s.aws \u0026quot;pipes-sqs-to-sqs\u0026quot; deleted\nnamespace \u0026quot;pipes-example\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Deleting Delays\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It might take some time for the Pipe to be deleted as the operation is performed asynchronously in the API.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eRemove the manually created SQS resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${SOURCE_QUEUE}\naws sqs delete-queue --queue-url https://sqs.${AWS_REGION}.amazonaws.com/${AWS_ACCOUNT_ID}/${TARGET_QUEUE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eRemove the manually created IAM resources.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam delete-role-policy --role-name ${PIPE_ROLE} --policy-name ${PIPE_POLICY}\naws iam delete-role --role-name ${PIPE_ROLE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf the command executes successfully, no output is generated.\u003c/p\u003e\n\u003cp\u003eTo remove the Pipes ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:26,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/sqs-example/",title:"Manage SQS queues with the ACK SQS Controller",description:"Create an SQS queue from an Amazon Elastic Kubernetes Service (EKS) deployment.",content:'\u003cp\u003eAmazon Simple Queue Service (SQS) is a fully managed message queuing service for microservices, distributed systems, and\nserverless applications. SQS lets you send, store, and receive messages between software components\nwithout losing messages or requiring other services to be available.\u003c/p\u003e\n\u003cp\u003eIn this tutorial you will learn how to create and manage \u003ca href="https://aws.amazon.com/sqs"\u003eSQS\u003c/a\u003e queues from an Amazon Elastic\nKubernetes (EKS) deployment.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster, see \u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS\nSetup\u003c/a\u003e.\nFor automated cluster creation using \u003ccode\u003eeksctl\u003c/code\u003e, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003eGetting started with Amazon EKS -\n\u003ccode\u003eeksctl\u003c/code\u003e\u003c/a\u003e and create your cluster with\nAmazon EC2 Linux managed nodes.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.24 or higher.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to send messages to a queue.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting\nwith AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working\nwith Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS\nclusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-sqs"\u003eInstall the ACK service controller for SQS\u003c/h3\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003e\u003cem\u003eNOTE:\u003c/em\u003e\u003c/strong\u003e This guide assumes you\u0026rsquo;re using \u003ccode\u003eus-east-1\u003c/code\u003e as the region where the ACK controller will be deployed, as well as the Amazon SQS resource. If you want to create the object in another resource, simply change the region name to your region of choice.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon SQS using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/sqs-chart"\u003esqs-chart Helm chart\u003c/a\u003e. If you\u0026rsquo;re looking to deploy resources to multiple regions, please refer to the \u003ca href="%5Burl%5D(https://aws-controllers-k8s.github.io/community/docs/user-docs/multi-region-resource-management/)"\u003eManage Resources In Multiple Regions\u003c/a\u003e documentation.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eCONTROLLER_REGION=us-east-1\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/sqs-chart --version=1.0.4 --generate-name --set=aws.region=$CONTROLLER_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/sqs-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed, you will need to \u003ca href="../../user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to query the SQS API. For full details, please review the AWS Controllers for Kubernetes documentation for\n\u003ca href="../../user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the value\nof \u003ccode\u003esqs\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-an-sqs-queue"\u003eCreate an SQS Queue\u003c/h2\u003e\n\u003cp\u003eExecute the following command to create a manifest for a basic SQS queue, with an inline policy with \u003ccode\u003eSendMessage\u003c/code\u003e\npermissions for the account owner, and submit this manifest to EKS cluster using kubectl.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Make sure environment variables are set\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you followed the steps in the IAM permissions section above, the required environment variables \u003ccode\u003e${AWS_REGION}\u003c/code\u003e and\n\u003ccode\u003e${AWS_ACCOUNT_ID}\u003c/code\u003e are already set. Otherwise please set these variables before executing the following steps. The value for \u003ccode\u003e${AWS_REGION}\u003c/code\u003e must also match the \u003ccode\u003e--set=aws.region\u003c/code\u003e value used in the \u003ccode\u003ehelm install\u003c/code\u003e command above.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eQUEUE_NAMESPACE=sqs-example\nQUEUE_NAME=basic-sqs\n\nkubectl create ns ${QUEUE_NAMESPACE}\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; basic-sqs-queue.yaml\napiVersion: sqs.services.k8s.aws/v1alpha1\nkind: Queue\nmetadata:\n name: ${QUEUE_NAME}\n annotations:\n services.k8s.aws/region: ${AWS_REGION}\nspec:\n queueName: ${QUEUE_NAME}\n policy: |\n {\n \u0026quot;Statement\u0026quot;: [{\n \u0026quot;Sid\u0026quot;: \u0026quot;__owner_statement\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;AWS\u0026quot;: \u0026quot;${AWS_ACCOUNT_ID}\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sqs:SendMessage\u0026quot;,\n \u0026quot;Resource\u0026quot;: \u0026quot;arn:aws:sqs:${AWS_REGION}:${AWS_ACCOUNT_ID}:${QUEUE_NAME}\u0026quot;\n }]\n }\nEOF\n\nkubectl -n ${QUEUE_NAMESPACE} create -f basic-sqs-queue.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003enamespace/sqs-example created\nqueue.sqs.services.k8s.aws/basic-sqs created\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="describe-sqs-custom-resource"\u003eDescribe SQS Custom Resource\u003c/h2\u003e\n\u003cp\u003eView the SQS custom resource to retrieve the \u003ccode\u003eQueue URL\u003c/code\u003e in the \u003ccode\u003eStatus\u003c/code\u003e field\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n $QUEUE_NAMESPACE describe queue $QUEUE_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eName: basic-sqs\nNamespace: sqs-example\n\u0026lt;snip\u0026gt;\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:sqs:us-east-1:1234567890:basic-sqs\n Owner Account ID: 1234567890\n Region: us-east-1\n Conditions:\n Last Transition Time: 2023-02-22T13:31:43Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Queue URL: https://sqs.us-east-1.amazonaws.com/1234567890/basic-sqs\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eCopy and set the Queue URL as an environment variable\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eQUEUE_URL=$(kubectl -n $QUEUE_NAMESPACE get queues/basic-sqs -o jsonpath=\'{.status.queueURL}\')\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="send-a-message"\u003eSend a Message\u003c/h2\u003e\n\u003cp\u003eExecute the following command to send a message to the queue\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs send-message --queue-url ${QUEUE_URL} --message-body \u0026quot;hello from ACK\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\n \u0026quot;MD5OfMessageBody\u0026quot;: \u0026quot;51e9ec3a483ba8b3159bc5fddcbbf36a\u0026quot;,\n \u0026quot;MessageId\u0026quot;: \u0026quot;281d7695-b066-4a50-853e-1b7c6c65f4a9\u0026quot;\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eVerify the message was received with\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws sqs receive-message --queue-url ${QUEUE_URL}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of above commands looks like\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\n \u0026quot;Messages\u0026quot;: [\n {\n \u0026quot;MessageId\u0026quot;: \u0026quot;281d7695-b066-4a50-853e-1b7c6c65f4a9\u0026quot;,\n \u0026quot;ReceiptHandle\u0026quot;: \u0026quot;ABCDeFZQxPfbAI201bRkdHZvRWeJUVSFfm2eL/T91L23ltB9nmf0dcx3ALQHz2WsXZhAbThZR+Ns5rX42+OjySNG6pi9Iu/SRZCVuuMzSBXeTrnLo8JjK3h9KE3uUkWirINgXd4fgVR2/C7feI3lCUhMOVhhYhec8ej5EDorL85Ay1IwZ43WYUQ1bIschP6xDvfzHk6vCi3kCXz6ZvPsNH3kTxp1gEvpQsaL/cq+aIZt/d1VVFsHtExbEk32iK1bo39tyA1A3Q7pT2WMowYh6MrfYdHoBw7PxJueGgx9MIQhQge2E+g6rKzGpFN9oPzPx59gu8n8n7Or6oncNM57pESD2LdzWTYjmS5H+Aw74qJ/gAMBIDNVuFt4Wl/5BvJHUTpOSAdi+Jekdbm3+AegzX8qyA==\u0026quot;,\n \u0026quot;MD5OfBody\u0026quot;: \u0026quot;51e9ec3a483ba8b3159bc5fddcbbf36a\u0026quot;,\n \u0026quot;Body\u0026quot;: \u0026quot;hello from ACK\u0026quot;\n }\n ]\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon SQS is based on the \u003ca href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/Welcome.html"\u003eAmazon SQS\nAPI\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eSQS\u003c/em\u003e to find all the supported\nKubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eRemove all the resource created in this tutorial using \u003ccode\u003ekubectl delete\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ${QUEUE_NAMESPACE} delete -f basic-sqs-queue.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe output of delete command should look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003equeue.sqs.services.k8s.aws \u0026quot;basic-sqs\u0026quot; deleted\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the SQS ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:27,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/lambda-oci-example/",title:"Create a Lambda OCI Function with the ACK Lambda Controller",description:"Create a Lambda Function with an OCI Image Using the ACK Lambda Controller deployed on Amazon Elastic Kubernetes Service (EKS).",content:'\u003cp\u003eThe ACK service controller for Amazon Lambda lets you manage Lambda functions directly from Kubernetes.\nThis guide shows you how to create a Lambda function with OCI image using a single Kubernetes resource manifest.\u003c/p\u003e\n\u003ch2 id="setup"\u003eSetup\u003c/h2\u003e\n\u003cp\u003eAlthough it is not necessary to use Amazon Elastic Kubernetes Service (Amazon EKS) or Amazon Elastic Container Registry (Amazon ECR) with ACK, this guide assumes that you\nhave access to an Amazon EKS cluster. If this is your first time creating an Amazon EKS cluster and Amazon ECR repository, see\n\u003ca href="https://docs.aws.amazon.com/deep-learning-containers/latest/devguide/deep-learning-containers-eks-setup.html"\u003eAmazon EKS Setup\u003c/a\u003e and \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/get-set-up-for-amazon-ecr.html"\u003eAmazon ECR Setup\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="prerequisites"\u003ePrerequisites\u003c/h3\u003e\n\u003cp\u003eThis guide assumes that you have:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreated an EKS cluster with Kubernetes version 1.16 or higher.\u003c/li\u003e\n\u003cli\u003eHave access to Amazon ECR\u003c/li\u003e\n\u003cli\u003eAWS IAM permissions to create roles and attach policies to roles.\u003c/li\u003e\n\u003cli\u003eInstalled the following tools on the client machine used to access your Kubernetes cluster:\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv1.html"\u003eAWS CLI\u003c/a\u003e - A command line tool for interacting with AWS services.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/install-kubectl.html"\u003ekubectl\u003c/a\u003e - A command line tool for working with Kubernetes clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003eeksctl\u003c/a\u003e - A command line tool for working with EKS clusters.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm 3.8+\u003c/a\u003e - A tool for installing and managing Kubernetes applications.\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/engine/install/"\u003eDocker\u003c/a\u003e - A tool to build, share, and run containers.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="install-the-ack-service-controller-for-lambda"\u003eInstall the ACK service controller for Lambda\u003c/h3\u003e\n\u003cp\u003eLog into the Helm registry that stores the ACK charts:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr-public get-login-password --region us-west-2 | helm registry login --username AWS --password-stdin public.ecr.aws\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDeploy the ACK service controller for Amazon Lambda using the \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/lambda-chart"\u003elambda-chart Helm chart\u003c/a\u003e. This example creates resources in the \u003ccode\u003eus-west-2\u003c/code\u003e region, but you can use any other region supported in AWS.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eSERVICE=lambda\nRELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nhelm install --create-namespace -n ack-system oci://public.ecr.aws/aws-controllers-k8s/lambda-chart \u0026quot;--version=${RELEASE_VERSION}\u0026quot; --generate-name --set=aws.region=us-west-2\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a full list of available values to the Helm chart, please \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/blob/main/helm/values.yaml"\u003ereview the values.yaml file\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="configure-iam-permissions"\u003eConfigure IAM permissions\u003c/h3\u003e\n\u003cp\u003eOnce the service controller is deployed \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003econfigure the IAM permissions\u003c/a\u003e for the\ncontroller to invoke the Lambda API. For full details, please review the AWS Controllers for Kubernetes documentation\nfor \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003ehow to configure the IAM permissions\u003c/a\u003e. If you follow the examples in the documentation, use the\nvalue of \u003ccode\u003elambda\u003c/code\u003e for \u003ccode\u003eSERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="create-lambda-function-handler"\u003eCreate Lambda function handler\u003c/h2\u003e\n\u003cp\u003eThe Lambda \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html"\u003efunction handler\u003c/a\u003e is the method in your function code that processes events. When your function is invoked, Lambda runs the handler method.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; app.js\nexports.handler = async (event) =\u0026gt; {\n const response = {\n statusCode: 200\n body: JSON.stringify(\'Hello from Lambda!\')\n };\n return response;\n};\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-and-build-a-docker-image"\u003eCreate and Build a Docker Image\u003c/h2\u003e\n\u003cp\u003eCreate a Dockerfile that will be used to build the image for our Lambda function:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; Dockerfile\nFROM public.ecr.aws/lambda/nodejs:14\n\nCOPY app.js package.json ./\n\nRUN npm install\n\nCMD [ \u0026quot;app.handler\u0026quot; ]\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBuild the Docker image in your local environment. You will need to install dependencies using \u003ccode\u003enpm\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003enpm init -y\ndocker build -t hello-world .\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="publish-the-docker-image-to-ecr"\u003ePublish the Docker image to ECR\u003c/h2\u003e\n\u003cp\u003ePublish the Docker image to an ECR repository. It\u0026rsquo;s a requirement for container images to be published to the ECR repository to run Lambda OCI image functions.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport AWS_REGION=us-west-2\n\naws ecr get-login-password --region us-west-2 | docker login --username AWS --password-stdin ${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com\naws ecr create-repository --repository-name hello-world --image-scanning-configuration scanOnPush=true --image-tag-mutability MUTABLE\ndocker tag \u0026quot;hello-world:latest ${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest\u0026quot;\ndocker push \u0026quot;${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="deploy-the-lambda-oci-function-using-the-ack-lambda-controller"\u003eDeploy the Lambda OCI function using the ACK Lambda controller\u003c/h2\u003e\n\u003cp\u003eThe following example creates a manifest that contains the Lambda OCI function. It then uses \u003ccode\u003ekubectl\u003c/code\u003e to create the resource in Kubernetes:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-shell"\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport IMAGE_URI=\u0026quot;${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_REGION}.amazonaws.com/hello-world:latest \u0026quot;\nexport FUNCTION_NAME=\u0026quot;lambda-oci-ack\u0026quot;\nexport LAMBDA_ROLE=\u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:role/lambda_basic_execution\u0026quot;\n\nread -r -d \'\' LAMBDA_MANIFEST \u0026lt;\u0026lt;EOF\napiVersion: lambda.services.k8s.aws/v1alpha1\nkind: Function\nmetadata:\n name: $FUNCTION_NAME\n annotations:\n services.k8s.aws/region: $AWS_REGION\nspec:\n name: $FUNCTION_NAME\n packageType: Image\n code:\n imageURI: $IMAGE_URI\n role: $LAMBDA_ROLE\n description: function created by ACK lambda-controller e2e tests\nEOF\n\necho \u0026quot;${LAMBDA_MANIFEST}\u0026quot; \u0026gt; function.yaml\n\nkubectl create -f function.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou should get a confirmation that the function was created successfully.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efunction.lambda.services.k8s.aws/lambda-oci-ack created\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo get details about the Lambda function, run the following.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl describe \u0026quot;function/${FUNCTION_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="invoke-the-lambda-oci-function"\u003eInvoke the Lambda OCI Function\u003c/h2\u003e\n\u003cp\u003eAfter you have verified that the Lambda OCI function is deployed correctly, you can invoke the function through the \u003ca href="https://docs.aws.amazon.com/cli/latest/reference/lambda/index.html"\u003eAWS CLI\u003c/a\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws lambda invoke --function-name ${FUNCTION_NAME} --region us-west-2 /dev/stdout | jq\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou will get the output as below:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e{\u0026quot;statusCode\u0026quot;:200,\u0026quot;body\u0026quot;:\u0026quot;\\\u0026quot;Hello from Lambda!\\\u0026quot;\u0026quot;} \n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext steps\u003c/h2\u003e\n\u003cp\u003eThe ACK service controller for Amazon Lambda is based on the \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_Reference.html"\u003eAmazon Lambda API\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eRefer to \u003ca href="https://aws-controllers-k8s.github.io/community/reference/"\u003eAPI Reference\u003c/a\u003e for \u003cem\u003eLambda\u003c/em\u003e to find\nall the supported Kubernetes custom resources and fields.\u003c/p\u003e\n\u003ch3 id="cleanup"\u003eCleanup\u003c/h3\u003e\n\u003cp\u003eYou can delete your Lambda OCI function using the \u003ccode\u003ekubectl delete\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -f function.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo remove the Lambda ACK service controller, related CRDs, and namespaces, see \u003ca href="../../user-docs/cleanup/"\u003eACK Cleanup\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eTo delete your EKS clusters, see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/delete-cluster.html"\u003eAmazon EKS - Deleting a cluster\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:28,href:"https://aws-controllers-k8s.github.io/community/docs/tutorials/emr-on-eks-example/",title:"Run Spark jobs using the ACK EMR on EKS controller",description:"ACK service controller for EMR on EKS enables customers to run spark jobs on EKS clusters",content:'\u003cp\u003eUsing ACK service controller for EMR on EKS, customers have the ability to define and run EMR jobs directly from their Kubernetes clusters. EMR on EKS manages the lifecycle of these jobs and it is \u003ca href="https://aws.amazon.com/blogs/big-data/amazon-emr-on-amazon-eks-provides-up-to-61-lower-costs-and-up-to-68-performance-improvement-for-spark-workloads/"\u003e3.5 times faster than open-source Spark\u003c/a\u003e because it uses highly optimized EMR runtime\u003c/p\u003e\n\u003cp\u003eTo get started, you can download the EMR on EKS controller image from \u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/emrcontainers-controller"\u003eAmazon ECR\u003c/a\u003e and run Spark jobs in minutes. ACK service controller for EMR on EKS is \u003cstrong\u003egenerally available\u003c/strong\u003e. To learn more about EMR on EKS, visit our \u003ca href="https://docs.aws.amazon.com/emr/latest/EMR-on-EKS-DevelopmentGuide/emr-eks.html"\u003edocumentation\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="installation-steps"\u003eInstallation steps\u003c/h2\u003e\n\u003cp\u003eHere are the steps involved for installing EMR on EKS controller.\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="#install-eks-cluster"\u003eInstall EKS cluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#create-iam-identity-mapping"\u003eCreate IAM Identity mapping\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="2"\u003e\n\u003cli\u003e\u003ca href="#install-emrcontainers-controller-in-your-eks-cluster"\u003eInstall emrcontainers-controller\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#configure-irsa-for-emr-on-eks-controller"\u003eConfigure IRSA for emr on eks controller\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="3"\u003e\n\u003cli\u003e\u003ca href="#create-emr-virtualcluster"\u003eCreate EMR VirtualCluster\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#create-job-execution-role"\u003eCreate EMR Job Execution Role \u0026amp; configure IRSA\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="4"\u003e\n\u003cli\u003e\u003ca href="#run-a-sample-spark-job"\u003eRun a sample job\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch4 id="prereqs"\u003ePrereqs\u003c/h4\u003e\n\u003cp\u003eInstall these tools before proceeding:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2-linux.html"\u003eAWS CLI\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ekubectl\u003c/code\u003e - \u003ca href="https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/"\u003ethe Kubernetes CLI\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eeksctl\u003c/code\u003e - \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/eksctl.html"\u003ethe CLI for AWS EKS\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eyq\u003c/code\u003e - \u003ca href="https://github.com/mikefarah/yq"\u003eYAML processor\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003ehelm\u003c/code\u003e - \u003ca href="https://helm.sh/docs/intro/install/"\u003ethe package manager for Kubernetes\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eConfigure AWS CLI with sufficient permissions to install EKS cluster. Please see \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/getting-started-eksctl.html"\u003edocumentation\u003c/a\u003e for further guidance\u003c/p\u003e\n\u003ch2 id="install-eks-cluster"\u003eInstall EKS cluster\u003c/h2\u003e\n\u003cp\u003eYou can either create an EKS cluster or re-use existing one. Below listed are steps for creating new EKS cluster. Let\u0026rsquo;s export environment variables that are needed for the EMR on EKS cluster setup. Please copy and paste commands into terminal for faster provisioning\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport AWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \u0026quot;Account\u0026quot; --output text)\nexport EKS_CLUSTER_NAME=\u0026quot;ack-emr-eks\u0026quot;\nexport AWS_REGION=\u0026quot;us-west-2\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe\u0026rsquo;ll use eksctl to install EKS cluster.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eeksctl create cluster -f - \u0026lt;\u0026lt; EOF\n---\napiVersion: eksctl.io/v1alpha5\nkind: ClusterConfig\nmetadata:\n name: ${EKS_CLUSTER_NAME}\n region: ${AWS_REGION}\n version: \u0026quot;1.23\u0026quot;\n\nmanagedNodeGroups:\n - instanceType: m5.xlarge\n name: ${EKS_CLUSTER_NAME}-ng\n desiredCapacity: 2\n\niam:\n withOIDC: true\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-iam-identity-mapping"\u003eCreate IAM Identity mapping\u003c/h4\u003e\n\u003cp\u003eWe need to create emr-containers identity in EKS cluster so that EMR service has proper RBAC permissions needed to run and manage Spark jobs\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport EMR_NAMESPACE=emr-ns\necho \u0026quot;creating namespace for $SERVICE\u0026quot;\nkubectl create ns $EMR_NAMESPACE\n\necho \u0026quot;creating iamidentitymapping using eksctl\u0026quot;\neksctl create iamidentitymapping \\\n --cluster $EKS_CLUSTER_NAME \\\n --namespace $EMR_NAMESPACE \\\n --service-name \u0026quot;emr-containers\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e2022-08-26 09:07:42 [ℹ] created \u0026quot;emr-ns:Role.rbac.authorization.k8s.io/emr-containers\u0026quot;\n2022-08-26 09:07:42 [ℹ] created \u0026quot;emr-ns:RoleBinding.rbac.authorization.k8s.io/emr-containers\u0026quot;\n2022-08-26 09:07:42 [ℹ] adding identity \u0026quot;arn:aws:iam::012345678910:role/AWSServiceRoleForAmazonEMRContainers\u0026quot; to auth ConfigMap\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="install-emrcontainers-controller-in-your-eks-cluster"\u003eInstall emrcontainers-controller in your EKS cluster\u003c/h2\u003e\n\u003cp\u003eNow we can go ahead and install EMR on EKS controller. First, let\u0026rsquo;s export environment variables needed for setup\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=emrcontainers\nexport RELEASE_VERSION=$(curl -sL https://api.github.com/repos/aws-controllers-k8s/${SERVICE}-controller/releases/latest | jq -r \'.tag_name | ltrimstr(\u0026quot;v\u0026quot;)\')\nexport ACK_SYSTEM_NAMESPACE=ack-system\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe cam use Helm for the installation\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;installing ack-$SERVICE-controller\u0026quot;\naws ecr-public get-login-password --region us-east-1 | helm registry login --username AWS --password-stdin public.ecr.aws\nhelm install --create-namespace -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller \\\n oci://public.ecr.aws/aws-controllers-k8s/$SERVICE-chart --version=$RELEASE_VERSION --set=aws.region=$AWS_REGION\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eNAME: ack-emrcontainers-controller\nLAST DEPLOYED: Fri Aug 26 09:05:08 2022\nNAMESPACE: ack-system\nSTATUS: deployed\nREVISION: 1\nTEST SUITE: None\nNOTES:\nemrcontainers-chart has been installed.\nThis chart deploys \u0026quot;public.ecr.aws/aws-controllers-k8s/emrcontainers-controller:0.0.6\u0026quot;.\n\nCheck its status by running:\n kubectl --namespace ack-system get pods -l \u0026quot;app.kubernetes.io/instance=ack-emrcontainers-controller\u0026quot;\n\nYou are now able to create Amazon EMR on EKS (EMRContainers) resources!\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="configure-irsa-for-emr-on-eks-controller"\u003eConfigure IRSA for emr on eks controller\u003c/h4\u003e\n\u003cp\u003eOnce the controller is deployed, you need to setup IAM permissions for the controller so that it can create and manage resources using EMR, S3 and other API\u0026rsquo;s. We will use \u003ca href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html"\u003eIAM Roles for Service Account\u003c/a\u003e to secure this IAM role so that only EMR on EKS controller service account can assume the permissions assigned.\u003c/p\u003e\n\u003cp\u003ePlease follow \u003ca href="https://aws-controllers-k8s.github.io/community/docs/user-docs/irsa/"\u003ehow to configure IAM permissions\u003c/a\u003e for IRSA setup. Make sure to change the value for \u003cstrong\u003e\u003ccode\u003eSERVICE\u003c/code\u003e\u003c/strong\u003e to \u003cstrong\u003e\u003ccode\u003eemrcontainers\u003c/code\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003cp\u003eAfter completing all the steps, please validate annotation for service account before proceeding.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e# validate annotation\nkubectl get pods -n $ACK_SYSTEM_NAMESPACE\nCONTROLLER_POD_NAME=$(kubectl get pods -n $ACK_SYSTEM_NAMESPACE --selector=app.kubernetes.io/name=emrcontainers-chart -o jsonpath=\'{.items..metadata.name}\')\nkubectl describe pod -n $ACK_SYSTEM_NAMESPACE $CONTROLLER_POD_NAME | grep \u0026quot;^\\s*AWS_\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eAWS_REGION: us-west-2\nAWS_ENDPOINT_URL: \nAWS_ROLE_ARN: arn:aws:iam::012345678910:role/ack-emrcontainers-controller\nAWS_WEB_IDENTITY_TOKEN_FILE: /var/run/secrets/eks.amazonaws.com/serviceaccount/token (http://eks.amazonaws.com/serviceaccount/token)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="create-emr-virtualcluster"\u003eCreate EMR VirtualCluster\u003c/h2\u003e\n\u003cp\u003eWe can now create EMR Virtual Cluster. An EMR Virtual Cluster is mapped to a Kubernetes namespace. EMR uses virtual clusters to run jobs and host endpoints.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt; EOF \u0026gt; virtualcluster.yaml\n---\napiVersion: emrcontainers.services.k8s.aws/v1alpha1\nkind: VirtualCluster\nmetadata:\n name: my-ack-vc\nspec:\n name: my-ack-vc\n containerProvider:\n id: $EKS_CLUSTER_NAME\n type_: EKS\n info:\n eksInfo:\n namespace: emr-ns\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLet\u0026rsquo;s create a virtualcluster\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eenvsubst \u0026lt; virtualcluster.yaml | kubectl apply -f -\nkubectl describe virtualclusters\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eName: my-ack-vc\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: emrcontainers.services.k8s.aws/v1alpha1\nKind: VirtualCluster\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:emr-containers:us-west-2:012345678910:/virtualclusters/dxnqujbxexzri28ph1wspbxo0\n Owner Account ID: 012345678910\n Region: us-west-2\n Conditions:\n Last Transition Time: 2022-08-26T17:21:26Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Id: dxnqujbxexzri28ph1wspbxo0\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="create-job-execution-role"\u003eCreate Job Execution Role\u003c/h4\u003e\n\u003cp\u003eIn order to run sample spark job, we need to create EMR Job Execution Role. This Role will have IAM permissions such as S3, CloudWatch Logs for running your job. We will use IRSA to secure this job role\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eACK_JOB_EXECUTION_ROLE=\u0026quot;ack-${SERVICE}-jobexecution-role\u0026quot;\nACK_JOB_EXECUTION_IAM_ROLE_DESCRIPTION=\u0026quot;IRSA role for ACK ${SERVICE} Job Execution\u0026quot;\n\ncat \u0026lt;\u0026lt;EOF \u0026gt; job_trust.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Sid\u0026quot;: \u0026quot;\u0026quot;,\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;Service\u0026quot;: \u0026quot;ec2.amazonaws.com\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;\n }\n ]\n}\nEOF\naws iam create-role --role-name \u0026quot;${ACK_JOB_EXECUTION_ROLE}\u0026quot; \\\n --assume-role-policy-document file://job_trust.json \\\n --description \u0026quot;${ACK_JOB_EXECUTION_IAM_ROLE_DESCRIPTION}\u0026quot;\n\nexport ACK_JOB_EXECUTION_ROLE_ARN=$(aws iam get-role --role-name=$ACK_JOB_EXECUTION_ROLE --query Role.Arn --output text) \n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003ecat \u0026lt;\u0026lt;EOF \u0026gt; job_policy.json\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: [\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;s3:PutObject\u0026quot;,\n \u0026quot;s3:GetObject\u0026quot;,\n \u0026quot;s3:ListBucket\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: \u0026quot;*\u0026quot;\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;s3:ListBucket\u0026quot;,\n \u0026quot;s3:GetObject*\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:s3:::tripdata\u0026quot;,\n \u0026quot;arn:aws:s3:::tripdata/*\u0026quot;\n ]\n },\n {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Action\u0026quot;: [\n \u0026quot;logs:PutLogEvents\u0026quot;,\n \u0026quot;logs:CreateLogStream\u0026quot;,\n \u0026quot;logs:DescribeLogGroups\u0026quot;,\n \u0026quot;logs:DescribeLogStreams\u0026quot;\n ],\n \u0026quot;Resource\u0026quot;: [\n \u0026quot;arn:aws:logs:*:*:*\u0026quot;\n ]\n }\n ]\n}\nEOF\necho \u0026quot;Creating ACK-${SERVICE}-JobExecution-POLICY\u0026quot;\naws iam create-policy \\\n --policy-name ack-${SERVICE}-jobexecution-policy \\\n --policy-document file://job_policy.json\n\necho -n \u0026quot;Attaching IAM policy ...\u0026quot;\naws iam attach-role-policy \\\n --role-name \u0026quot;${ACK_JOB_EXECUTION_ROLE}\u0026quot; \\\n --policy-arn \u0026quot;arn:aws:iam::${AWS_ACCOUNT_ID}:policy/ack-${SERVICE}-jobexecution-policy\u0026quot;\n\naws emr-containers update-role-trust-policy \\\n --cluster-name ${EKS_CLUSTER_NAME} \\\n --namespace ${EMR_NAMESPACE} \\\n --role-name ${ACK_JOB_EXECUTION_ROLE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="run-a-sample-spark-job"\u003eRun a Sample Spark Job\u003c/h2\u003e\n\u003cp\u003eBefore running a sample job, let\u0026rsquo;s create CloudWatch Logs and an S3 bucket to store EMR on EKS logs\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eexport RANDOM_ID1=$(LC_ALL=C tr -dc a-z0-9 \u0026lt;/dev/urandom | head -c 8)\n\naws logs create-log-group --log-group-name=/emr-on-eks-logs/$EKS_CLUSTER_NAME\naws s3 mb s3://$EKS_CLUSTER_NAME-$RANDOM_ID1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow let\u0026rsquo;s submit sample spark job\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;checking if VirtualCluster Status is \u0026quot;True\u0026quot;\u0026quot;\nVC=$(kubectl get virtualcluster -o jsonpath=\'{.items..metadata.name}\')\nkubectl describe virtualcluster/$VC | yq e \'.Status.Conditions.Status\'\n\nexport RANDOM_ID2=$(LC_ALL=C tr -dc a-z0-9 \u0026lt;/dev/urandom | head -c 8)\n\ncat \u0026lt;\u0026lt; EOF \u0026gt; jobrun.yaml\n---\napiVersion: emrcontainers.services.k8s.aws/v1alpha1\nkind: JobRun\nmetadata:\n name: my-ack-jobrun-${RANDOM_ID2}\nspec:\n name: my-ack-jobrun-${RANDOM_ID2}\n virtualClusterRef:\n from:\n name: my-ack-vc\n executionRoleARN: \u0026quot;${ACK_JOB_EXECUTION_ROLE_ARN}\u0026quot;\n releaseLabel: \u0026quot;emr-6.7.0-latest\u0026quot;\n jobDriver:\n sparkSubmitJobDriver:\n entryPoint: \u0026quot;local:///usr/lib/spark/examples/src/main/python/pi.py\u0026quot;\n entryPointArguments:\n sparkSubmitParameters: \u0026quot;--conf spark.executor.instances=2 --conf spark.executor.memory=1G --conf spark.executor.cores=1 --conf spark.driver.cores=1\u0026quot;\n configurationOverrides: |\n ApplicationConfiguration: null\n MonitoringConfiguration:\n CloudWatchMonitoringConfiguration:\n LogGroupName: /emr-on-eks-logs/$EKS_CLUSTER_NAME\n LogStreamNamePrefix: pi-job\n S3MonitoringConfiguration:\n LogUri: s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 \nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003eecho \u0026quot;running sample job\u0026quot;\nkubectl apply -f jobrun.yaml\nkubectl describe jobruns\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eExpected outcome\u003c/strong\u003e\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003eName: my-ack-jobrun-t2rpcpks\nNamespace: default\nLabels: \u0026lt;none\u0026gt;\nAnnotations: \u0026lt;none\u0026gt;\nAPI Version: emrcontainers.services.k8s.aws/v1alpha1\nKind: JobRun\n...\nStatus:\n Ack Resource Metadata:\n Arn: arn:aws:emr-containers:us-west-2:012345678910:/virtualclusters/dxnqujbxexzri28ph1wspbxo0/jobruns/000000030mrd934cdqc\n Owner Account ID: 012345678910\n Region: us-west-2\n Conditions:\n Last Transition Time: 2022-08-26T18:29:12Z\n Message: Resource synced successfully\n Reason: \n Status: True\n Type: ACK.ResourceSynced\n Id: 000000030mrd934cdqc\nEvents: \u0026lt;none\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="cleanup"\u003eCleanup\u003c/h2\u003e\n\u003cp\u003eSimply run these commands to cleanup your environment\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e# delete all custom resources\nkubectl delete -f virtualcluster.yaml\nkubectl delete -f jobrun.yaml\n# note: you cannot delete jobruns until virtualcluster its mapped to is deleted\n\n# uninstall emrcontainers controller\nhelm delete ack-$SERVICE-controller -n $ACK_SYSTEM_NAMESPACE\n\n# delete namespace\nkubectl delete ns $ACK_SYSTEM_NAMESPACE\nkubectl delete ns $EMR_NAMESPACE\n\n# delete aws resources\naws logs delete-log-group --log-group-name=/emr-on-eks-logs/$EKS_CLUSTER_NAME\naws s3 rm s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 --recursive\naws s3 rb s3://$EKS_CLUSTER_NAME-$RANDOM_ID1 \n\n# delete EKS cluster\neksctl delete cluster --name \u0026quot;${EKS_CLUSTER_NAME}\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="limitations"\u003eLimitations\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eYou cannot delete a JobRun unless its in \u003cstrong\u003eerror\u003c/strong\u003e state. There is no delete-job-run API for deleting jobs (for good reason). However, if your JobRun goes into error state, you can run \u003ccode\u003ekubectl delete jobrun/\u0026lt;job-run-name\u0026gt;\u003c/code\u003e to cancel the job.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="troubleshooting"\u003eTroubleshooting\u003c/h2\u003e\n\u003cul\u003e\n\u003cli\u003eIf you run into issues creating VirtualCluster or JobRuns, check EMR on EKS controller logs for troubleshooting\u003c/li\u003e\n\u003c/ul\u003e\n\u003cpre\u003e\u003ccode\u003eCONTROLLER_POD=$(kubectl get pod -n ${ACK_SYSTEM_NAMESPACE} -o jsonpath=\'{.items..metadata.name}\')\nkubectl logs ${CONTROLLER_POD} -n ${ACK_SYSTEM_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cul\u003e\n\u003cli\u003eYou can enable debug logs for EMR on EKS controller if you are unable to determine cause of the error. You need to change values for \u003ccode\u003eenable-development-logging\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and \u003ccode\u003e--log-level\u003c/code\u003e to \u003ccode\u003edebug\u003c/code\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003cpre\u003e\u003ccode\u003eCONTROLLER_DEPLOYMENT=$(kubectl get deploy -n ${ACK_SYSTEM_NAMESPACE} -o jsonpath=\'{.items..metadata.name}\')\nkubectl edit deploy/${CONTROLLER_DEPLOYMENT} -n ${ACK_SYSTEM_NAMESPACE}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis is how your values should look after changes are applied.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e - --aws-region\n - $(AWS_REGION)\n - --aws-endpoint-url\n - $(AWS_ENDPOINT_URL)\n - --enable-development-logging\n - \u0026quot;true\u0026quot;\n - --log-level\n - debug\n - --resource-tags\n - $(ACK_RESOURCE_TAGS)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cul\u003e\n\u003cli\u003eIf you run into any issue, please create \u003ca href="https://github.com/aws-controllers-k8s/community/issues"\u003eGithub issue\u003c/a\u003e. Click \u003cstrong\u003eNew issue\u003c/strong\u003e and select the type of issue, add \u003ccode\u003e[emr-containers] \u0026lt;highlevel overview\u0026gt;\u003c/code\u003e under title, and add enough details so that we can reproduce and provide a response\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:29,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/building-controller/",title:"Building a Controller",description:"How to build or regenerate an ACK service controller",content:'\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eYou should have forked the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\nrepository and \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d it locally when \u003ca href="../setup"\u003esetting up\u003c/a\u003e your\ndevelopment environment,\u003c/p\u003e\n\u003cp\u003eWith the prerequisites out of the way, let\u0026rsquo;s move on to the first step:\nbuilding the code generator.\u003c/p\u003e\n\u003ch2 id="build-code-generator"\u003eBuild code generator\u003c/h2\u003e\n\u003cp\u003eBuilding an ACK service controller (or regenerating an existing one from a\nnewer API model file) requires the \u003ccode\u003eack-generate\u003c/code\u003e binary, which is the main\ncode generator CLI tool.\u003c/p\u003e\n\u003cp\u003eTo build the latest \u003ccode\u003eack-generate\u003c/code\u003e binary, execute the following command from\nthe root directory of the \u003ccode\u003egithub.com/aws-controllers-k8s/code-generator\u003c/code\u003e\nsource repository:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake build-ack-generate\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n One-off build\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n You only have to do this once, overall. In other words: unless we change\nsomething upstream in terms of the code generation process, this is\na one-off operation. Internally, the Makefile executes an \u003ccode\u003ego build\u003c/code\u003e here.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eDon\u0026rsquo;t worry if you forget this step, the script in the next step will complain\nwith a message along the line of \u003ccode\u003eERROR: Unable to find an ack-generate binary\u003c/code\u003e\nand will give you another opportunity to rectify the situation.\u003c/p\u003e\n\u003ch2 id="build-an-ack-service-controller"\u003eBuild an ACK service controller\u003c/h2\u003e\n\u003cp\u003eNow that we have the basic code generation step done we will create the\nrespective ACK service controller and its supporting artifacts.\u003c/p\u003e\n\u003cp\u003eSo first you have to select a service that you want to build and test.\nYou do that by setting the \u003ccode\u003eSERVICE\u003c/code\u003e environment variable. Let\u0026rsquo;s say we want\nto test the S3 service (creating an S3 bucket), so we would execute the\nfollowing:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we are in a position to generate the ACK service controller for the S3 API.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake build-controller SERVICE=$SERVICE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eBy default, running \u003ccode\u003emake build-controller\u003c/code\u003e will output the generated code to\nACK service controller for S3\u0026rsquo;s source code repository (the\n\u003ccode\u003e$GOPATH/src/github.com/aws-controllers-k8s/s3-controller\u003c/code\u003e directory). You can\noverride this behaviour with the \u003ccode\u003eSERVICE_CONTROLLER_SOURCE_PATH\u003c/code\u003e environment\nvariable.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Handle \u003ccode\u003econtroller-gen: command not found\u003c/code\u003e\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you run into the \u003ccode\u003econtroller-gen: command not found\u003c/code\u003e message when\nexecuting \u003ccode\u003emake build-controller\u003c/code\u003e then you want to check if the\n\u003ccode\u003econtroller-gen\u003c/code\u003e binary is available in \u003ccode\u003e$GOPATH/bin\u003c/code\u003e, also ensure that \u003ccode\u003e$GOPATH/bin\u003c/code\u003e is part of your \u003ccode\u003e$PATH\u003c/code\u003e, see also\n\u003ca href="https://github.com/aws/aws-controllers-k8s/issues/234"\u003e\u003ccode\u003e#234\u003c/code\u003e\u003c/a\u003e.\nYou can also install the required version of \u003ccode\u003econtroller-gen\u003c/code\u003e using the\n\u003ccode\u003escripts/install-controller-gen.sh\u003c/code\u003e helper script.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn addition to the ACK service controller code, above generates the\ncustom resource definition (CRD) manifests as well as the necessary RBAC\nsettings using the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/scripts/build-controller.sh"\u003e\u003ccode\u003e/scripts/build-controller.sh\u003c/code\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eNow that we have the generation part completed, we want to see if the\ngenerated artifacts indeed are able to create an S3 bucket for us.\u003c/p\u003e\n\u003cp\u003eLearn about how to \u003ca href="../testing"\u003erun e2e tests for an ACK controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:30,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/cross-account-resource-management/",title:"Manage Resources In Multiple AWS Accounts",description:"Managing resources in different AWS accounts",content:'\u003cp\u003eACK service controllers can manage resources in different AWS accounts. To enable and start using this feature, as an administrator, you will need to:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eConfigure the AWS accounts where the resources will be managed\u003c/li\u003e\n\u003cli\u003eMap AWS accounts with the Role ARNs that need to be assumed\u003c/li\u003e\n\u003cli\u003eAnnotate namespaces with AWS Account IDs\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eFor detailed information about how ACK service controllers manage resources in multiple AWS accounts, please refer to the Cross-Account Resource Management (CARM) \u003ca href="https://github.com/aws-controllers-k8s/community/blob/main/docs/design/proposals/carm/cross-account-resource-management.md"\u003edesign document\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-note"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n To use CARM, \u003ccode\u003e--watch-namespace\u003c/code\u003e must be empty\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK service controllers may be started in either Cluster Mode or Namespace Mode. When a service controller is started in Namespace Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag is supplied and the controller will \u003cem\u003eonly\u003c/em\u003e watch for custom resources (CRs) in that Kubernetes Namespace. Because the cross-account resource management feature requires the controller to watch for custom resources on many Kubernetes Namespaces, this feature is incompatible with the Namespace Mode of running a controller and thus the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag must not be set (or be set to an empty string).\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="step-1-configure-your-aws-accounts"\u003eStep 1: Configure your AWS accounts\u003c/h2\u003e\n\u003cp\u003eAWS account administrators should create and configure IAM roles to allow ACK service controllers to assume roles in different AWS accounts.\u003c/p\u003e\n\u003cp\u003eTo allow account A (000000000000) to create AWS S3 buckets in account B (111111111111), you can use the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003e# Using account B credentials\naws iam create-role --role-name s3FullAccess \\\n --assume-role-policy-document \'{\u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\u0026quot;Statement\u0026quot;: [{ \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;, \u0026quot;Principal\u0026quot;: {\u0026quot;AWS\u0026quot;: \u0026quot;arn:aws:iam::000000000000:role/roleA-production\u0026quot;}, \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;}]}\'\naws iam attach-role-policy --role-name s3FullAccess \\\n --policy-arn \'arn:aws:iam::aws:policy/service-role/AmazonS3FullAccess\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-2-map-aws-accounts-to-their-associated-role-arns"\u003eStep 2: Map AWS accounts to their associated role ARNs\u003c/h2\u003e\n\u003cp\u003eCreate a \u003ccode\u003eConfigMap\u003c/code\u003e to associate each AWS Account ID with the role ARN that needs to be assumed in order to manage resources in that particular account.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: ack-role-account-map\n namespace: $ACK_SYSTEM_NAMESPACE\ndata:\n \u0026quot;111111111111\u0026quot;: arn:aws:iam::111111111111:role/s3FullAccess\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="step-3-bind-accounts-to-namespaces"\u003eStep 3: Bind accounts to namespaces\u003c/h2\u003e\n\u003cp\u003eTo bind AWS accounts to a specific namespace you will have to annotate the namespace with an AWS account ID. For example:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: Namespace\nmetadata:\n name: production\n annotations:\n services.k8s.aws/owner-account-id: \u0026quot;111111111111\u0026quot;\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor existing namespaces, you can run:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl annotate namespace production services.k8s.aws/owner-account-id=111111111111\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="create-resources-in-different-aws-accounts"\u003eCreate resources in different AWS accounts\u003c/h3\u003e\n\u003cp\u003eNext, create your custom resources (CRs) in the associated namespace.\u003c/p\u003e\n\u003cp\u003eFor example, to create an S3 bucket in account B, run the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: my-bucket\n namespace: production\nspec:\n name: my-bucket\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eCheckout the \u003ca href="../authorization"\u003eRBAC and IAM permissions overview\u003c/a\u003e to understand how ACK manages authorization\u003c/p\u003e\n'}).add({id:31,href:"https://aws-controllers-k8s.github.io/community/docs/community/releases/",title:"Release Phases",description:"Releases, Versioning and Maintenance Phases",content:'\u003cp\u003eService controllers are built in separate source code repositories. Below, you\nwill find a description of the \u003ca href="#project-stages"\u003eProject Stages\u003c/a\u003e that a service\ncontroller repository goes through on its way to being released.\u003c/p\u003e\n\u003cp\u003eA controller that has reached the \u003ccode\u003eRELEASED\u003c/code\u003e project stage will have a set of\nrelease artifacts, including binary container images for the controller and a Helm\nChart that installs the controller into a target Kubernetes cluster. Read more\nbelow about our \u003ca href="#releases-and-versioning"\u003eReleases and Versioning policy\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eFinally, we have a set of documented \u003ca href="#maintenance-phases"\u003eMaintenance Phases\u003c/a\u003e\nthat clearly outline our support stance for service controllers that have been\nreleased.\u003c/p\u003e\n\u003ch2 id="project-stages"\u003eProject Stages\u003c/h2\u003e\n\u003cp\u003eThe controller\u0026rsquo;s \u0026ldquo;project stage\u0026rdquo; describes how far along the controller is\ntowards being released:\u003c/p\u003e\n\u003cp\u003e\u003ca href="#proposed"\u003e\u003ccode\u003ePROPOSED\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#planned"\u003e\u003ccode\u003ePLANNED\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#in-progress"\u003e\u003ccode\u003eIN PROGRESS\u003c/code\u003e\u003c/a\u003e -\u0026gt; \u003ca href="#released"\u003e\u003ccode\u003eRELEASED\u003c/code\u003e\u003c/a\u003e\u003c/p\u003e\n\u003ch3 id="proposed"\u003ePROPOSED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003ePROPOSED\u003c/code\u003e stage indicates that there is expressed interest in supporting\nan AWS service in ACK.\u003c/p\u003e\n\u003cp\u003eAt this stage, there will be a Github Issue and/or a Github Project for\ntracking the creation of the ACK service controller for the service.\u003c/p\u003e\n\u003cp\u003eThe GitHub Issue \u003cstrong\u003eWILL NOT\u003c/strong\u003e be associated with a GitHub Milestone.\u003c/p\u003e\n\u003ch3 id="planned"\u003ePLANNED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003ePLANNED\u003c/code\u003e stage indicates that we plan to make a controller for this\nservice available in ACK.\u003c/p\u003e\n\u003cp\u003eAt this stage, there \u003cstrong\u003eWILL BE\u003c/strong\u003e a GitHub Milestone that tracks progress\ntowards the release of the controller.\u003c/p\u003e\n\u003ch3 id="in-progress"\u003eIN PROGRESS\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003eIN PROGRESS\u003c/code\u003e stage indicates that the ACK service controller for the AWS\nservice is \u003cstrong\u003eactively being built\u003c/strong\u003e in preparation for a release of that ACK\nservice controller.\u003c/p\u003e\n\u003cp\u003eIn the \u003ccode\u003eIN PROGRESS\u003c/code\u003e stage we identify those \u003cstrong\u003eAWS service API resources\u003c/strong\u003e that\nwill be supported by the controller and generate the code that manages the\nlifecycle of these resources.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n What do we mean by \u0026lsquo;AWS service API resources\u0026rsquo;?\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n An \u003cem\u003eAWS service API resource\u003c/em\u003e is a top-level object that can be created by\na particular AWS service API. For example, an SNS Topic or an S3 Bucket.\nSome service APIs have multiple top-level resources; SNS, for instance, has\nTopic, PlatformApplication and PlatformEndpoint top-level resources that\nmay be created.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="released"\u003eRELEASED\u003c/h3\u003e\n\u003cp\u003eThe \u003ccode\u003eRELEASED\u003c/code\u003e project stage indicates that the ACK service controller source\nrepository has had a Semantic Versioning Git tag applied and that both a container\nimage and Helm Chart have been built and published to the ECR Public\nrepositories for ACK.\u003c/p\u003e\n\u003cp\u003eOnce a service controller reaches the \u003ccode\u003eRELEASED\u003c/code\u003e project stage, that \u003cstrong\u003edoes not\nmean\u003c/strong\u003e that there can never be any changes or additions to the Custom Resource\nDefinitions (CRDs) or public interfaces exposed by that service controller. The\n\u003ccode\u003eRELEASED\u003c/code\u003e project stage is simply an indication that there is at least one\nSemVer-tagged binary release of the controller.\u003c/p\u003e\n\u003cp\u003eConsumers should look to the SemVer release tag as an indication of whether\ncode included in that release introduces new breaking (major version increment)\nor non-breaking features (minor version increment) or simply bug fixes (patch\nversion increment). Consumers should see release notes for a release tag for a\nfull description of changes included in that release.\u003c/p\u003e\n\u003ch2 id="releases-and-versioning"\u003eReleases and Versioning\u003c/h2\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-danger"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Important\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n ACK does \u003cem\u003enot\u003c/em\u003e have a single release status or version.\nDifferent components within the ACK project have different release cadences,\nversions and statuses. Please read the information below before installing\nany ACK component.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eService controllers in ACK use \u003ca href="#semantic-versioning"\u003eSemantic Versioning\u003c/a\u003e to\nindicate whether changes included in a particular binary release introduce\nfeatures or bug fixes and whether or not features break backwards compatibility\nfor public APIs and interfaces.\u003c/p\u003e\n\u003cp\u003eThere are two release artifacts produced when an ACK service controller is\nreleased: a binary \u003cstrong\u003econtainer image\u003c/strong\u003e with the controller and a \u003cstrong\u003eHelm Chart\u003c/strong\u003e\nthat installs the controller into a target Kubernetes cluster. Both these\nartifacts will have tags that correspond to the Semantic Version Git tag\napplied against the source code repository for the controller.\u003c/p\u003e\n\u003ch3 id="semantic-versioning"\u003eSemantic Versioning\u003c/h3\u003e\n\u003cp\u003eACK is a collection of custom Kubernetes controllers, one for each supported\nAWS API. Each ACK controller is composed of an \u003ca href="https://github.com/aws-controllers-k8s/runtime"\u003eACK common runtime\u003c/a\u003e and\nGo code that links the Kubernetes API and the AWS API. Much of this Go code is\ngenerated by the \u003ca href="https://github.com/aws-controllers-k8s/code-generator"\u003e\u003ccode\u003eack-generate\u003c/code\u003e\u003c/a\u003e tool; some of the Go code is\nhand-crafted.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eAll code components\u003c/strong\u003e in ACK use \u003ca href="https://semver.org/"\u003eSemantic Versioning\u003c/a\u003e (SemVer) as a\nsignal to consumers whether public interfaces or APIs have breaking changes.\u003c/p\u003e\n\u003cp\u003eWhen an ACK component is \u003cem\u003e\u003cstrong\u003ereleased\u003c/strong\u003e\u003c/em\u003e, a Git tag containing a SemVer (X.Y.Z)\nis created on the component\u0026rsquo;s source repository. If the commits to the source\nrepository in between the last Git tag and the commit being tagged have\nintroduced changes that break public-facing APIs or interfaces, the SemVer will\nhave its major version (\u0026ldquo;X\u0026rdquo;) incremented. If the commits introduce\nfunctionality that does not break interfaces or APIs, the minor version (\u0026ldquo;Y\u0026rdquo;)\nwill be incremented. If the commits simply fix bugs and do not introduce any\nfeatures or interface changes, the patch version (\u0026ldquo;Z\u0026rdquo;) will be incremented.\u003c/p\u003e\n\u003cp\u003eReleases of any ACK component that have a zero major release number (e.g.\n\u003ccode\u003e0.0.2\u003c/code\u003e) may have breaking changes to the public API or interfaces exposed by\nthat component.\u003c/p\u003e\n\u003cp\u003eThis is by design, and \u003ca href="https://semver.org/#spec-item-4"\u003eper the Semantic Versioning specification\u003c/a\u003e:\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003eMajor version zero (0.y.z) is for initial development. Anything MAY change at\nany time. The public API SHOULD NOT be considered stable.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eFor ACK components that have a binary distributable \u0026ndash; i.e. a container image \u0026ndash;\nthe creation of a new SemVer Git tag on the source code repository triggers the\nautomatic building and publishing of a container image with an image tag including\nthe SemVer version.\u003c/p\u003e\n\u003cp\u003eFor example, if a Git tag of \u003ccode\u003ev1.2.6\u003c/code\u003e was created on the\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/a\u003e repository, a container\nimage with a tag \u003ccode\u003e1.2.6\u003c/code\u003e would be published to the\n\u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-controller"\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller\u003c/a\u003e ECR Public\nrepository.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Binaries for individual ACK service controllers components are published in\nseparate Amazon ECR Public repositories.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eFor ACK components that have a Helm Chart distributable \u0026ndash; i.e. an ACK service\ncontroller \u0026ndash; the creation of a new SemVer Git tag on the source code\nrepository triggers automatic building and publishing of a Helm Chart with\nan artifact tag including the SemVer version.\u003c/p\u003e\n\u003cp\u003eFor example, a Git tag of \u003ccode\u003ev1.2.6\u003c/code\u003e on the\n\u003ca href="https://github.com/aws-controllers-k8s/s3-controller"\u003egithub.com/aws-controllers-k8s/s3-controller\u003c/a\u003e\nrepository means a Helm chart with a tag \u003ccode\u003e1.2.6\u003c/code\u003e would be published to the\n\u003ca href="https://gallery.ecr.aws/aws-controllers-k8s/s3-chart"\u003epublic.ecr.aws/aws-controllers-k8s/s3-chart\u003c/a\u003e ECR Public\nrepository.\u003c/p\u003e\n\u003ch4 id="a-word-about-dependencies"\u003eA Word About Dependencies\u003c/h4\u003e\n\u003cp\u003eEach service-specific ACK controller \u0026ndash; e.g. the ElastiCache ACK controller \u0026ndash;\ndepends on a specific version of the ACK common runtime. This dependency is\nspecified in the controller\u0026rsquo;s \u003ccode\u003ego.mod\u003c/code\u003e file.\u003c/p\u003e\n\u003cp\u003eThe ACK code generator that produces Go code for service controllers depends on\na specific version of the ACK common runtime.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Dependency between the code generator and common runtime\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The ACK code generator depends on the ACK common runtime in a unique way:\nthe Go code that the ACK code generator \u003cem\u003eproduces\u003c/em\u003e adheres to a specific\nversion of the ACK common runtime. Even though no Go code in the ACK code\ngenerator actually imports the ACK common runtime, this dependency exists\nbecause the Go code produced by the templates inside the code generator imports\nthe ACK common runtime. In order to make this Go code dependency more strict,\nwe have a test package inside the ACK code generator that imports the ACK\ncommon runtime. In this way, we\u0026rsquo;re able to include a version-specific\ndependency line in the ACK code generator\u0026rsquo;s \u003ccode\u003ego.mod\u003c/code\u003e file, thereby allowing\nGo\u0026rsquo;s module infrastructure to pin the dependency between the code generator and\nthe common runtime.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="maintenance-phases"\u003eMaintenance Phases\u003c/h2\u003e\n\u003cp\u003eAs noted above, individual ACK service controllers all use Semantic Versioning\n(\u0026ldquo;X.Y.Z\u0026rdquo;) in order to signal breaking interface changes. However, each\ncontroller follows its own release cadence and each controller has a separate\nteam of contributors that maintain the code, test the controller and determine\nwhether the controller is stable in long-running operation.\u003c/p\u003e\n\u003cp\u003eACK service controllers having release tags within a major Semantic Version\n(\u0026ldquo;X\u0026rdquo;) will be in one of four Maintenance Phases:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ca href="#preview"\u003ePREVIEW\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="#general-availability"\u003eGENERAL AVAILABILITY\u003c/a\u003e (GA)\u003c/li\u003e\n\u003cli\u003e\u003ca href="#deprecated"\u003eDEPRECATED\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="#not-supported"\u003eNOT SUPPORTED\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch3 id="preview"\u003ePreview\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003ePreview\u003c/code\u003e Maintenance Phase are released for testing by\nusers and are not recommended for production use.\u003c/p\u003e\n\u003cp\u003eFor \u003ccode\u003ePreview\u003c/code\u003e controllers, we ask users to submit bug reports using Github\nIssues and we will do our best to remediate problems in a timely manner.\u003c/p\u003e\n\u003ch3 id="general-availability"\u003eGeneral Availability\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e (GA) Maintenance Phase have been\nthrough long-running \u0026ldquo;soak\u0026rdquo; tests and are recommended for production use by the\nteam maintaining that controller.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e Maintenance Phase will have a\nHelm Chart tagged with the major version \u0026gt;0 (eg. \u003ccode\u003e1.0.0\u003c/code\u003e).\u003c/p\u003e\n\u003cp\u003eUsers who submit bug reports using Github Issues that reference a \u003ccode\u003eGeneral Availability\u003c/code\u003e controller will have their bug reports prioritized by the\ncontributor team maintaining that controller.\u003c/p\u003e\n\u003ch3 id="deprecated"\u003eDeprecated\u003c/h3\u003e\n\u003cp\u003eACK controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e Maintenance Phase may move to a\n\u003ccode\u003eDeprecated\u003c/code\u003e Maintenance Phase after a Deprecation Warning notice has been sent\nout (and the controller\u0026rsquo;s documentation has been updated with said deprecation\nnotice).\u003c/p\u003e\n\u003cp\u003eControllers in \u003ccode\u003eDeprecated\u003c/code\u003e Maintenance Phase continue to receive the same\nlevel of support as controllers in the \u003ccode\u003eGeneral Availability\u003c/code\u003e phase.\u003c/p\u003e\n\u003ch3 id="not-supported"\u003eNot Supported\u003c/h3\u003e\n\u003cp\u003eACK controllers may eventually be moved into a \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase.\u003c/p\u003e\n\u003cp\u003eA controller major version series may move from the \u003ccode\u003ePreview\u003c/code\u003e Maintenance Phase\nto the \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase at any time. This may happen if the\nteam maintaining the controller determines it is not possible to get the\ncontroller with that major version series into a \u003ccode\u003eGeneral Availability\u003c/code\u003e phase.\u003c/p\u003e\n\u003cp\u003eA controller major version series may move from the \u003ccode\u003eDeprecated\u003c/code\u003e\nMaintenance Phase to the \u003ccode\u003eNot Supported\u003c/code\u003e Maintenance Phase \u003cem\u003eonly after a 1-year\ndeprecation period has elapsed\u003c/em\u003e.\u003c/p\u003e\n'}).add({id:32,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/drift-recovery/",title:"Recovering from Drift",description:"Recovering from Drift",content:'\u003cp\u003eKubernetes controllers work on the principal of \u003ca href="https://book.kubebuilder.io/cronjob-tutorial/controller-overview.html#whats-in-a-controller"\u003econstant\nreconciliation\u003c/a\u003e. In essence, they continuously look at\nthe current desired state of the system and compare it to the actual state,\nusing the difference to determine the action required to get to the desired end\nresult.\u003c/p\u003e\n\u003cp\u003eOnce a controller has reconciled a resource to its desired state, the controller\nshouldn\u0026rsquo;t need to continue reconciling - the actual state of the resource meets\nthe specification. However, this is only true for closed systems, where the\ncontroller is the only actor interacting with a resource. Unfortunately, ACK\ncontrollers don\u0026rsquo;t act in a closed system. ACK controllers are not the only actor\ncapable of modifying the actual state of any AWS resources - other programs, or\neven people, may have their own privileges. When another actor modifies a\nresource after the ACK controller has reconciled it to its desired state, that\u0026rsquo;s\ncalled \u0026ldquo;drift\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eACK controllers detect drift by continuing to reconcile resources after they\nhave reached their desired state, but with much longer delays between\nreconciliation attempts. By default, all ACK controllers attempt to detect drift\nonce every \u003cstrong\u003e10 hours\u003c/strong\u003e. That is, every 10 hours after a resource has been\nmarked with the \u003ccode\u003eResourceSynced = true\u003c/code\u003e condition, its owner controller will\ndescribe the resource in AWS to see if it no longer matches the desired state.\nIf the controller detects a difference, it then starts the reconciliation loop\nagain to get back to that state (just as when any other change has been made).\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Existing resource overrides\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eSome resources require more frequent drift remediation. For example, if a\nresource runs a stateful workload whose status changes frequently (such as a\nSageMaker \u003ccode\u003eTrainingJob\u003c/code\u003e). For these resources, the drift remediation period may\nalready have been decreased by the controller authors to improve the\nresponsiveness of the resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eAll override periods are logged to stdout when the controller is started.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch2 id="overriding-the-drift-remediation-period"\u003eOverriding the drift remediation period\u003c/h2\u003e\n\u003ch3 id="for-all-resources-owned-by-a-controller"\u003eFor all resources owned by a controller\u003c/h3\u003e\n\u003cp\u003eIf you would like to decrease the drift remediation period for \u003cem\u003eall\u003c/em\u003e resources\nowned by a controller, update the \u003ccode\u003ereconcile.defaultResyncPeriod\u003c/code\u003e value in the\nHelm chart \u003ccode\u003evalues.yaml\u003c/code\u003e file with the number of seconds for the new period,\nlike so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ereconcile:\n defaultResyncPeriod: 1800 # 30 minutes (in seconds)\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="for-a-single-resource-type"\u003eFor a single resource type\u003c/h3\u003e\n\u003cp\u003eThe most granular configuration for setting reconciliation periods is to apply\nit to all resources of a given type. For example, all S3 \u003ccode\u003eBucket\u003c/code\u003e managed by a\nsingle controller.\u003c/p\u003e\n\u003cp\u003eAdd the resource name and the overriding period (in seconds) to the\n\u003ccode\u003ereconcile.resourceResyncPeriods\u003c/code\u003e value in the Helm chart \u003ccode\u003evalues.yaml\u003c/code\u003e like\nso:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ereconcile:\n resourceResyncPeriods:\n Bucket: 1800 # 30 minutes (in seconds)\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:33,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/code-generator-config/",title:"Understanding generator.yaml configuration",description:"Understanding the ACK generator.yaml configuration file",content:'\u003ch1 id="understanding-generatoryaml-configuration"\u003eUnderstanding generator.yaml Configuration\u003c/h1\u003e\n\u003cp\u003eThis document describes the various configuration fields in a \u003ccode\u003egenerator.yaml\u003c/code\u003e file that can be used to control the API inference and code generation for an ACK controller.\u003c/p\u003e\n\u003cp\u003eWe will show examples of configuring specific ACK controllers to highlight various configuration options.\u003c/p\u003e\n\u003ch2 id="generate-a-resource-manager-package"\u003eGenerate a resource manager package\u003c/h2\u003e\n\u003cp\u003eFor this section, we will use \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/Welcome.html"\u003eECR\u003c/a\u003e as our example service API.\u003c/p\u003e\n\u003cp\u003eWhen creating a new ACK controller, after running the \u003ca href="https://github.com/aws-controllers-k8s/controller-bootstrap"\u003e\u003ccode\u003econtroller-bootstrap\u003c/code\u003e\u003c/a\u003e program, you will be left with a \u003ccode\u003egenerator.yaml\u003c/code\u003e that has all inferred API resources ignored.\u003c/p\u003e\n\u003cp\u003eFor the ECR controller, the \u003ccode\u003egenerator.yaml\u003c/code\u003e file would look like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n - Repository\n - PullThroughCacheRule\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf we ran \u003ccode\u003emake build-controller SERVICE=ecr\u003c/code\u003e with the above \u003ccode\u003egenerator.yaml\u003c/code\u003e file, we would have some basic directories and files created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash="\u003e[jaypipes@thelio code-generator]$ make build-controller SERVICE=ecr\nbuilding ack-generate ... ok.\n==== building ecr-controller ====\nCopying common custom resource definitions into ecr\nBuilding Kubernetes API objects for ecr\nGenerating deepcopy code for ecr\nGenerating custom resource definitions for ecr\nBuilding service controller for ecr\nGenerating RBAC manifests for ecr\nRunning gofmt against generated code for ecr\nUpdating additional GitHub repository maintenance files\n==== building ecr-controller release artifacts ====\nBuilding release artifacts for ecr-v0.0.0-non-release\nGenerating common custom resource definitions\nGenerating custom resource definitions for ecr\nGenerating RBAC manifests for ecr\n\u003c/code\u003e\u003c/pre\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio ecr-controller]$ tree apis/ config/ pkg/\napis/\n└── v1alpha1\n ├── ack-generate-metadata.yaml\n ├── doc.go\n ├── enums.go\n ├── generator.yaml\n ├── groupversion_info.go\n └── types.go\nconfig/\n├── controller\n│ ├── deployment.yaml\n│ ├── kustomization.yaml\n│ └── service.yaml\n├── crd\n│ ├── common\n│ │ ├── bases\n│ │ │ ├── services.k8s.aws_adoptedresources.yaml\n│ │ │ └── services.k8s.aws_fieldexports.yaml\n│ │ └── kustomization.yaml\n│ └── kustomization.yaml\n├── default\n│ └── kustomization.yaml\n├── overlays\n│ └── namespaced\n│ ├── kustomization.yaml\n│ ├── role-binding.json\n│ └── role.json\n└── rbac\n ├── cluster-role-binding.yaml\n ├── cluster-role-controller.yaml\n ├── kustomization.yaml\n ├── role-reader.yaml\n ├── role-writer.yaml\n └── service-account.yaml\npkg/\n├── resource\n│ └── registry.go\n└── version\n └── version.go\n\n11 directories, 25 files\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo begin generating a particular resource manager, comment out the name of the resource from the ignore list and run \u003ccode\u003emake build-controller SERVICE=$SERVICE\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n\u0026gt; #- Repository\n - PullThroughCacheRule\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter doing so, the resource manager for \u003ccode\u003eRepository\u003c/code\u003e resources will have been generated in the \u003ccode\u003eecr-controller\u003c/code\u003e source code repository.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio ecr-controller]$ tree apis/ config/ pkg/\napis/\n└── v1alpha1\n ├── ack-generate-metadata.yaml\n ├── doc.go\n ├── enums.go\n ├── generator.yaml\n ├── groupversion_info.go\n ├── repository.go\n ├── types.go\n └── zz_generated.deepcopy.go\nconfig/\n├── controller\n│ ├── deployment.yaml\n│ ├── kustomization.yaml\n│ └── service.yaml\n├── crd\n│ ├── bases\n│ │ └── ecr.services.k8s.aws_repositories.yaml\n│ ├── common\n│ │ ├── bases\n│ │ │ ├── services.k8s.aws_adoptedresources.yaml\n│ │ │ └── services.k8s.aws_fieldexports.yaml\n│ │ └── kustomization.yaml\n│ └── kustomization.yaml\n├── default\n│ └── kustomization.yaml\n├── overlays\n│ └── namespaced\n│ ├── kustomization.yaml\n│ ├── role-binding.json\n│ └── role.json\n└── rbac\n ├── cluster-role-binding.yaml\n ├── cluster-role-controller.yaml\n ├── kustomization.yaml\n ├── role-reader.yaml\n ├── role-writer.yaml\n └── service-account.yaml\npkg/\n├── resource\n│ ├── registry.go\n│ └── repository\n│ ├── delta.go\n│ ├── descriptor.go\n│ ├── identifiers.go\n│ ├── manager_factory.go\n│ ├── manager.go\n│ ├── references.go\n│ ├── resource.go\n│ ├── sdk.go\n│ └── tags.go\n└── version\n └── version.go\n\n13 directories, 37 files\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNote the new files under \u003ccode\u003epkg/resource/repository/\u003c/code\u003e, \u003ccode\u003eapis/v1alpha1/repository.go\u003c/code\u003e and \u003ccode\u003econfig/crd/bases/\u003c/code\u003e. These files represent the Go type for the generated \u003ccode\u003eRepository\u003c/code\u003e custom resource definition (CRD), the resource manager package and the YAML representation for the CRD, respectively.\u003c/p\u003e\n\u003ch2 id="renames-renaming-things"\u003e\u003ccode\u003erenames\u003c/code\u003e: Renaming things\u003c/h2\u003e\n\u003cp\u003eWhy might we want to rename fields or resources? Generally, there are two reasons for this:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ereducing stutter in the input shape\u003c/li\u003e\n\u003cli\u003ecorrecting instances where a field is named differently in the input and output shapes\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe first reason is to reduce \u0026ldquo;stutter\u0026rdquo; (or redundancy) in naming. For example, the ECR \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L2"\u003e\u003ccode\u003eRepository\u003c/code\u003e\u003c/a\u003e resource has a field called \u003ccode\u003eRepositoryName\u003c/code\u003e. This field is redundantly named because the resource itself is called \u003ccode\u003eRepository\u003c/code\u003e. Every Kubernetes object has a \u003ccode\u003eMetadata.Name\u003c/code\u003e field and we like to align resource \u0026ldquo;name fields\u0026rdquo; with this simple \u003ccode\u003eName\u003c/code\u003e moniker.\u003c/p\u003e\n\u003cp\u003eFor this example, let\u0026rsquo;s go ahead and \u0026ldquo;destutter\u0026rdquo; the \u003ccode\u003eRepositoryName\u003c/code\u003e field. To do this, we use the \u003ccode\u003erenames\u003c/code\u003e configuration option, specifying the input and output shapes and their members that we want to rename:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\nresources:\n Repository:\n\u0026gt; renames:\n\u0026gt; operations:\n\u0026gt; CreateRepository:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u0026gt; DeleteRepository:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u0026gt; DescribeRepositories:\n\u0026gt; input_fields:\n\u0026gt; RepositoryName: Name\n\u003c/code\u003e\u003c/pre\u003e\n\u003cblockquote\u003e\n\u003cp\u003e📝 Note that we must tell the code generator which fields to rename in the input shapes for each API operation that the resource manager will call. In the case of ECR \u003ccode\u003eRepository\u003c/code\u003e resources, the resource manager calls the \u003ccode\u003eCreateRepository\u003c/code\u003e, \u003ccode\u003eDeleteRepository\u003c/code\u003e and \u003ccode\u003eDescribeRepositories\u003c/code\u003e API calls and so we need specify the \u003ccode\u003eRepositoryName\u003c/code\u003e member field in each of those input shapes should be renamed to \u003ccode\u003eName\u003c/code\u003e.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003cp\u003eAfter calling \u003ccode\u003emake build-controller SERVICE=ecr\u003c/code\u003e, we see the above generator configuration items produced the following diff:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-diff="\u003ediff --git a/apis/v1alpha1/ack-generate-metadata.yaml b/apis/v1alpha1/ack-generate-metadata.yaml\nindex e34e029..f214b43 100755\n--- a/apis/v1alpha1/ack-generate-metadata.yaml\n+++ b/apis/v1alpha1/ack-generate-metadata.yaml\n@@ -1,13 +1,13 @@\n ack_generate_info:\n- build_date: \u0026quot;2022-11-09T20:15:42Z\u0026quot;\n+ build_date: \u0026quot;2022-11-09T20:16:52Z\u0026quot;\n build_hash: 5ee0ac052c54f008dff50f6f5ebb73f2cf3a0bd7\n go_version: go1.18.1\n version: v0.20.1-4-g5ee0ac0\n-api_directory_checksum: 0a514bef9cff983f9fe28f080d85725ccf578060\n+api_directory_checksum: 84fb59a0991980da922a385f585111a1ff784d82\n api_version: v1alpha1\n aws_sdk_go_version: v1.44.93\n generator_config_info:\n- file_checksum: 87446926d73abae9355e6328eb7f8f668b16b18e\n+ file_checksum: a383007f82a686dc544879792dde7b091aeededa\n original_file_name: generator.yaml\n last_modification:\n reason: API generation\ndiff --git a/apis/v1alpha1/generator.yaml b/apis/v1alpha1/generator.yaml\nindex cb7045a..ed0130f 100644\n--- a/apis/v1alpha1/generator.yaml\n+++ b/apis/v1alpha1/generator.yaml\n@@ -2,3 +2,16 @@ ignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\n+resources:\n+ Repository:\n+ renames:\n+ operations:\n+ CreateRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DeleteRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DescribeRepositories:\n+ input_fields:\n+ RepositoryName: Name\ndiff --git a/apis/v1alpha1/repository.go b/apis/v1alpha1/repository.go\nindex c226d4f..fc6165d 100644\n--- a/apis/v1alpha1/repository.go\n+++ b/apis/v1alpha1/repository.go\n@@ -35,15 +35,15 @@ type RepositorySpec struct {\n // be overwritten. If IMMUTABLE is specified, all image tags within the repository\n // will be immutable which will prevent them from being overwritten.\n ImageTagMutability *string `json:\u0026quot;imageTagMutability,omitempty\u0026quot;`\n- // The Amazon Web Services account ID associated with the registry to create\n- // the repository. If you do not specify a registry, the default registry is\n- // assumed.\n- RegistryID *string `json:\u0026quot;registryID,omitempty\u0026quot;`\n // The name to use for the repository. The repository name may be specified\n // on its own (such as nginx-web-app) or it can be prepended with a namespace\n // to group the repository into a category (such as project-a/nginx-web-app).\n // +kubebuilder:validation:Required\n- RepositoryName *string `json:\u0026quot;repositoryName\u0026quot;`\n+ Name *string `json:\u0026quot;name\u0026quot;`\n+ // The Amazon Web Services account ID associated with the registry to create\n+ // the repository. If you do not specify a registry, the default registry is\n+ // assumed.\n+ RegistryID *string `json:\u0026quot;registryID,omitempty\u0026quot;`\n // The metadata that you apply to the repository to help you categorize and\n // organize them. Each tag consists of a key and an optional value, both of\n // which you define. Tag keys can have a maximum character length of 128 characters,\ndiff --git a/apis/v1alpha1/zz_generated.deepcopy.go b/apis/v1alpha1/zz_generated.deepcopy.go\nindex 93919be..88dd4c0 100644\n--- a/apis/v1alpha1/zz_generated.deepcopy.go\n+++ b/apis/v1alpha1/zz_generated.deepcopy.go\n@@ -421,13 +421,13 @@ func (in *RepositorySpec) DeepCopyInto(out *RepositorySpec) {\n *out = new(string)\n **out = **in\n }\n- if in.RegistryID != nil {\n- in, out := \u0026amp;in.RegistryID, \u0026amp;out.RegistryID\n+ if in.Name != nil {\n+ in, out := \u0026amp;in.Name, \u0026amp;out.Name\n *out = new(string)\n **out = **in\n }\n- if in.RepositoryName != nil {\n- in, out := \u0026amp;in.RepositoryName, \u0026amp;out.RepositoryName\n+ if in.RegistryID != nil {\n+ in, out := \u0026amp;in.RegistryID, \u0026amp;out.RegistryID\n *out = new(string)\n **out = **in\n }\ndiff --git a/config/crd/bases/ecr.services.k8s.aws_repositories.yaml b/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\nindex 438785e..9657569 100644\n--- a/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\n+++ b/config/crd/bases/ecr.services.k8s.aws_repositories.yaml\n@@ -61,17 +61,17 @@ spec:\n all image tags within the repository will be immutable which will\n prevent them from being overwritten.\n type: string\n- registryID:\n- description: The Amazon Web Services account ID associated with the\n- registry to create the repository. If you do not specify a registry,\n- the default registry is assumed.\n- type: string\n- repositoryName:\n+ name:\n description: The name to use for the repository. The repository name\n may be specified on its own (such as nginx-web-app) or it can be\n prepended with a namespace to group the repository into a category\n (such as project-a/nginx-web-app).\n type: string\n+ registryID:\n+ description: The Amazon Web Services account ID associated with the\n+ registry to create the repository. If you do not specify a registry,\n+ the default registry is assumed.\n+ type: string\n tags:\n description: The metadata that you apply to the repository to help\n you categorize and organize them. Each tag consists of a key and\n@@ -92,7 +92,7 @@ spec:\n type: object\n type: array\n required:\n- - repositoryName\n+ - name\n type: object\n status:\n description: RepositoryStatus defines the observed state of Repository\ndiff --git a/generator.yaml b/generator.yaml\nindex cb7045a..ed0130f 100644\n--- a/generator.yaml\n+++ b/generator.yaml\n@@ -2,3 +2,16 @@ ignore:\n resource_names:\n #- Repository\n - PullThroughCacheRule\n+resources:\n+ Repository:\n+ renames:\n+ operations:\n+ CreateRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DeleteRepository:\n+ input_fields:\n+ RepositoryName: Name\n+ DescribeRepositories:\n+ input_fields:\n+ RepositoryName: Name\ndiff --git a/helm/crds/ecr.services.k8s.aws_repositories.yaml b/helm/crds/ecr.services.k8s.aws_repositories.yaml\nindex 438785e..9657569 100644\n--- a/helm/crds/ecr.services.k8s.aws_repositories.yaml\n+++ b/helm/crds/ecr.services.k8s.aws_repositories.yaml\n@@ -61,17 +61,17 @@ spec:\n all image tags within the repository will be immutable which will\n prevent them from being overwritten.\n type: string\n- registryID:\n- description: The Amazon Web Services account ID associated with the\n- registry to create the repository. If you do not specify a registry,\n- the default registry is assumed.\n- type: string\n- repositoryName:\n+ name:\n description: The name to use for the repository. The repository name\n may be specified on its own (such as nginx-web-app) or it can be\n prepended with a namespace to group the repository into a category\n (such as project-a/nginx-web-app).\n type: string\n+ registryID:\n+ description: The Amazon Web Services account ID associated with the\n+ registry to create the repository. If you do not specify a registry,\n+ the default registry is assumed.\n+ type: string\n tags:\n description: The metadata that you apply to the repository to help\n you categorize and organize them. Each tag consists of a key and\n@@ -92,7 +92,7 @@ spec:\n type: object\n type: array\n required:\n- - repositoryName\n+ - name\n type: object\n status:\n description: RepositoryStatus defines the observed state of Repository\ndiff --git a/pkg/resource/repository/delta.go b/pkg/resource/repository/delta.go\nindex a15d260..57b54df 100644\n--- a/pkg/resource/repository/delta.go\n+++ b/pkg/resource/repository/delta.go\n@@ -77,6 +77,13 @@ func newResourceDelta(\n delta.Add(\u0026quot;Spec.ImageTagMutability\u0026quot;, a.ko.Spec.ImageTagMutability, b.ko.Spec.ImageTagMutability)\n }\n }\n+ if ackcompare.HasNilDifference(a.ko.Spec.Name, b.ko.Spec.Name) {\n+ delta.Add(\u0026quot;Spec.Name\u0026quot;, a.ko.Spec.Name, b.ko.Spec.Name)\n+ } else if a.ko.Spec.Name != nil \u0026amp;\u0026amp; b.ko.Spec.Name != nil {\n+ if *a.ko.Spec.Name != *b.ko.Spec.Name {\n+ delta.Add(\u0026quot;Spec.Name\u0026quot;, a.ko.Spec.Name, b.ko.Spec.Name)\n+ }\n+ }\n if ackcompare.HasNilDifference(a.ko.Spec.RegistryID, b.ko.Spec.RegistryID) {\n delta.Add(\u0026quot;Spec.RegistryID\u0026quot;, a.ko.Spec.RegistryID, b.ko.Spec.RegistryID)\n } else if a.ko.Spec.RegistryID != nil \u0026amp;\u0026amp; b.ko.Spec.RegistryID != nil {\n@@ -84,13 +91,6 @@ func newResourceDelta(\n delta.Add(\u0026quot;Spec.RegistryID\u0026quot;, a.ko.Spec.RegistryID, b.ko.Spec.RegistryID)\n }\n }\n- if ackcompare.HasNilDifference(a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName) {\n- delta.Add(\u0026quot;Spec.RepositoryName\u0026quot;, a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName)\n- } else if a.ko.Spec.RepositoryName != nil \u0026amp;\u0026amp; b.ko.Spec.RepositoryName != nil {\n- if *a.ko.Spec.RepositoryName != *b.ko.Spec.RepositoryName {\n- delta.Add(\u0026quot;Spec.RepositoryName\u0026quot;, a.ko.Spec.RepositoryName, b.ko.Spec.RepositoryName)\n- }\n- }\n if !reflect.DeepEqual(a.ko.Spec.Tags, b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n }\ndiff --git a/pkg/resource/repository/resource.go b/pkg/resource/repository/resource.go\nindex e15d755..a2dd27e 100644\n--- a/pkg/resource/repository/resource.go\n+++ b/pkg/resource/repository/resource.go\n@@ -88,7 +88,7 @@ func (r *resource) SetIdentifiers(identifier *ackv1alpha1.AWSIdentifiers) error\n if identifier.NameOrID == \u0026quot;\u0026quot; {\n return ackerrors.MissingNameIdentifier\n }\n- r.ko.Spec.RepositoryName = \u0026amp;identifier.NameOrID\n+ r.ko.Spec.Name = \u0026amp;identifier.NameOrID\n \n f2, f2ok := identifier.AdditionalKeys[\u0026quot;registryID\u0026quot;]\n if f2ok {\ndiff --git a/pkg/resource/repository/sdk.go b/pkg/resource/repository/sdk.go\nindex 4366244..61a0053 100644\n--- a/pkg/resource/repository/sdk.go\n+++ b/pkg/resource/repository/sdk.go\n@@ -132,9 +132,9 @@ func (rm *resourceManager) sdkFind(\n ko.Status.ACKResourceMetadata.ARN = \u0026amp;tmpARN\n }\n if elem.RepositoryName != nil {\n- ko.Spec.RepositoryName = elem.RepositoryName\n+ ko.Spec.Name = elem.RepositoryName\n } else {\n- ko.Spec.RepositoryName = nil\n+ ko.Spec.Name = nil\n }\n if elem.RepositoryUri != nil {\n ko.Status.RepositoryURI = elem.RepositoryUri\n@@ -158,7 +158,7 @@ func (rm *resourceManager) sdkFind(\n func (rm *resourceManager) requiredFieldsMissingFromReadManyInput(\n r *resource,\n ) bool {\n- return r.ko.Spec.RepositoryName == nil\n+ return r.ko.Spec.Name == nil\n \n }\n \n@@ -172,9 +172,9 @@ func (rm *resourceManager) newListRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n+ if r.ko.Spec.Name != nil {\n f3 := []*string{}\n- f3 = append(f3, r.ko.Spec.RepositoryName)\n+ f3 = append(f3, r.ko.Spec.Name)\n res.SetRepositoryNames(f3)\n }\n \n@@ -253,9 +253,9 @@ func (rm *resourceManager) sdkCreate(\n ko.Status.ACKResourceMetadata.ARN = \u0026amp;arn\n }\n if resp.Repository.RepositoryName != nil {\n- ko.Spec.RepositoryName = resp.Repository.RepositoryName\n+ ko.Spec.Name = resp.Repository.RepositoryName\n } else {\n- ko.Spec.RepositoryName = nil\n+ ko.Spec.Name = nil\n }\n if resp.Repository.RepositoryUri != nil {\n ko.Status.RepositoryURI = resp.Repository.RepositoryUri\n@@ -298,8 +298,8 @@ func (rm *resourceManager) newCreateRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n- res.SetRepositoryName(*r.ko.Spec.RepositoryName)\n+ if r.ko.Spec.Name != nil {\n+ res.SetRepositoryName(*r.ko.Spec.Name)\n }\n if r.ko.Spec.Tags != nil {\n f5 := []*svcsdk.Tag{}\n@@ -362,8 +362,8 @@ func (rm *resourceManager) newDeleteRequestPayload(\n if r.ko.Spec.RegistryID != nil {\n res.SetRegistryId(*r.ko.Spec.RegistryID)\n }\n- if r.ko.Spec.RepositoryName != nil {\n- res.SetRepositoryName(*r.ko.Spec.RepositoryName)\n+ if r.ko.Spec.Name != nil {\n+ res.SetRepositoryName(*r.ko.Spec.Name)\n }\n \n return res, nil\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou will note that there were changes made to the \u003ccode\u003erepository.go\u003c/code\u003e file, the \u003ccode\u003epkg/resource/repository/sdk.go\u003c/code\u003e.\u003c/p\u003e\n\u003ch3 id="renaming-things-with-different-names-in-input-and-output-shapes"\u003eRenaming things with different names in input and output shapes\u003c/h3\u003e\n\u003cp\u003eThe second reason we might need to rename a field is when the same field goes by different names in the \u003cem\u003eshapes\u003c/em\u003e (i.e., expected syntax) of the input and output. An hypothetical example of this might be a field that is called \u003ccode\u003eEnableEncryption\u003c/code\u003e in an input shape and \u003ccode\u003eEncryptionEnabled\u003c/code\u003e in an output shape. In order to inform the code generator that these fields are actually the same, we would rename one of the fields to match the other.\u003c/p\u003e\n\u003cp\u003e[\u003cstrong\u003e\u003cem\u003eTODO\u003c/em\u003e\u003c/strong\u003e this needs a concrete example of renaming with both \u003ccode\u003einput_fields\u003c/code\u003e and \u003ccode\u003eoutput_fields\u003c/code\u003e]\u003c/p\u003e\n\u003ch2 id="ignore-ignoring-things"\u003e\u003ccode\u003eignore\u003c/code\u003e: Ignoring things\u003c/h2\u003e\n\u003cp\u003eSometimes you want to instruct the code generator to simply ignore a particular API Operation, or a particular field in an API Shape. See \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/pull/89"\u003ehere\u003c/a\u003e for a real world motivating example of such a need.\u003c/p\u003e\n\u003cp\u003eYou will use the \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/f6dd767f12429832bc7b4321fb7b763a9fa997c7/pkg/config/config.go#L50-L66"\u003e\u003ccode\u003eignore:\u003c/code\u003e\u003c/a\u003e block of configuration options to do this.\u003c/p\u003e\n\u003cp\u003eTo ignore a specific field in an API Shape, you can list the field via fieldpath in the \u003ccode\u003eignore.fieldpaths\u003c/code\u003e configuration option.\u003c/p\u003e\n\u003cp\u003eAn \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/blob/9adb7703fa9e8c422a583ec1c8da35ecb21c8917/generator.yaml#L8-L12"\u003eexample\u003c/a\u003e of this can be found in the S3 controller\u0026rsquo;s \u003ccode\u003egenerator.yaml\u003c/code\u003e file:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n field_paths:\n # We cannot support MFA, so if it is set we cannot unset\n - \u0026quot;VersioningConfiguration.MFADelete\u0026quot;\n # This subfield struct has no members...\n - \u0026quot;NotificationConfiguration.EventBridgeConfiguration\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhen you specify a field path in \u003ccode\u003eignore.field_paths\u003c/code\u003e, the code generator will skip over that field when inferring custom resource definition \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e structures.\u003c/p\u003e\n\u003ch2 id="tags"\u003eTags\u003c/h2\u003e\n\u003cp\u003e\u003cem\u003eMost\u003c/em\u003e resources in AWS service APIs can have one or more tags associated with them. Tags are \u003cem\u003etypically\u003c/em\u003e simple string key/value pairs; however, the representation of tags across different AWS service APIs is not consistent. Some APIs use a \u003ccode\u003emap[string]string\u003c/code\u003e to represent tags. Others use a \u003ccode\u003e[]struct{}\u003c/code\u003e where the struct has a \u003ccode\u003eKey\u003c/code\u003e and a \u003ccode\u003eValue\u003c/code\u003e field. Others use more complex structures.\u003c/p\u003e\n\u003ch3 id="tagsignore-telling-ack-code-generator-that-a-resource-does-not-support-tags"\u003e\u003ccode\u003etags.ignore\u003c/code\u003e: Telling ACK code generator that a resource does not support tags\u003c/h3\u003e\n\u003cp\u003eThere are some API resources that \u003cem\u003edo not\u003c/em\u003e support tags at all, and we want a way to skip the generation of code that handles tagging for those resources. By default, for all resources, ACK generates some code that handles conversion between the ACK standard representation of tags (i.e., \u003ccode\u003emap[string]string\u003c/code\u003e) and the AWS service-specific representation of tags (e.g., \u003ccode\u003e[]struct{}\u003c/code\u003e, etc).\u003c/p\u003e\n\u003cp\u003eIf you attempt to generate a resource manager for a resource that does not support tags, you will receive an error from the code generator. ECR\u0026rsquo;s \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreatePullThroughCacheRule.html"\u003e\u003ccode\u003ePassThroughCacheRule\u003c/code\u003e\u003c/a\u003e is an example of a resource that does not support tags. If we unignore the \u003ccode\u003ePassThroughCacheRule\u003c/code\u003e resource in the ECR controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L78"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file and regenerate the controller, we will stumble upon this error:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e[jaypipes@thelio code-generator]$ make build-controller SERVICE=ecr\nbuilding ack-generate ... ok.\n==== building ecr-controller ====\nCopying common custom resource definitions into ecr\nBuilding Kubernetes API objects for ecr\nGenerating deepcopy code for ecr\nGenerating custom resource definitions for ecr\nBuilding service controller for ecr\nError: template: /home/jaypipes/go/src/github.com/aws-controllers-k8s/code-generator/templates/pkg/resource/manager.go.tpl:282:20: executing \u0026quot;/home/jaypipes/go/src/github.com/aws-controllers-k8s/code-generator/templates/pkg/resource/manager.go.tpl\u0026quot; at \u0026lt;.CRD.GetTagField\u0026gt;: error calling GetTagField: tag field path Tags does not exist inside PullThroughCacheRule crd\nmake: *** [Makefile:41: build-controller] Error 1\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTo fix this error, we used the \u003ccode\u003etags.ignore\u003c/code\u003e configuration option in \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L78"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eignore:\n resource_names:\n #- Repository\n #- PullThroughCacheRule\nresources:\n Repository:\n renames:\n operations:\n CreateRepository:\n input_fields:\n RepositoryName: Name\n DeleteRepository:\n input_fields:\n RepositoryName: Name\n DescribeRepositories:\n input_fields:\n RepositoryName: Name\n PullThroughCacheRule:\n fields:\n ECRRepositoryPrefix:\n is_primary_key: true\n \u0026gt; tags:\n \u0026gt; ignore: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="resource-configuration"\u003eResource configuration\u003c/h2\u003e\n\u003ch3 id="understanding-resource-identifying-fields"\u003eUnderstanding resource-identifying fields\u003c/h3\u003e\n\u003cp\u003eAll resources in the AWS world have one or more fields that serve as primary key identifiers. Most people are familiar with the \u003ccode\u003eARN\u003c/code\u003e fields that most modern AWS resources have. However, the \u003ccode\u003eARN\u003c/code\u003e field is not the only field that can serve as a primary key for a resource. ACK\u0026rsquo;s code generator reads an API model file and attempts to determine which fields on a resource can be used to uniquely identify that resource. Sometimes, though, the code generator needs to be instructed which field or fields comprise this primary key. \u003ca href="#Field-level-configuration-of-identifying-fields"\u003eSee below\u003c/a\u003e for an example from ECR\u0026rsquo;s \u003ccode\u003ePullThroughCacheRule\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThere are resource-level and field-level configuration options that inform the code generator about identifying fields.\u003c/p\u003e\n\u003ch4 id="is_arn_primary_key-resource-level-configuration-of-identifying-fields"\u003e\u003ccode\u003eis_arn_primary_key\u003c/code\u003e: Resource-level configuration of identifying fields\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003eresources[$resource].is_arn_primary_key\u003c/code\u003e configuration option is a boolean, defaulting to \u003ccode\u003efalse\u003c/code\u003e that instructs the code generator to use the \u003ccode\u003eARN\u003c/code\u003e field when calling the \u0026ldquo;ReadOne\u0026rdquo; (i.e., \u0026ldquo;Describe\u0026rdquo; or \u0026ldquo;Get\u0026rdquo;) operation for that resource. When \u003ccode\u003efalse\u003c/code\u003e, the code generator will look for \u0026ldquo;identifier fields\u0026rdquo; with field names such as \u003ccode\u003eID\u003c/code\u003e or \u003ccode\u003eName\u003c/code\u003e (along with variants that include the resource name as a prefix, e.g., \u0026ldquo;BucketName\u0026rdquo;).\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eis_arn_primary_key=true\u003c/code\u003e configuration option \u003cem\u003ewhen the resource has no other identifying fields\u003c/em\u003e. An example of this is SageMaker\u0026rsquo;s \u003ccode\u003eModelPackage\u003c/code\u003e resource that has no \u003ccode\u003eName\u003c/code\u003e or \u003ccode\u003eID\u003c/code\u003e field and can only be identified via an \u003ccode\u003eARN\u003c/code\u003e field:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n ModelPackage:\n is_arn_primary_key: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003e[NOTE(jaypipes): Probably want to reevaluate this particular config option and use the field-centric is_primary_key option instead\u0026hellip;]\u003c/em\u003e\u003c/p\u003e\n\u003ch4 id="is_primary_key-field-level-configuration-of-identifying-fields"\u003e\u003ccode\u003eis_primary_key\u003c/code\u003e: Field-level configuration of identifying fields\u003c/h4\u003e\n\u003cp\u003eSometimes a resource\u0026rsquo;s primary key field is non-obvious (like \u003ccode\u003eName\u003c/code\u003e or \u003ccode\u003eID\u003c/code\u003e). Use the \u003ccode\u003eresources[$resource]fields[$field].is_primary_key\u003c/code\u003e configuration option to tell the code generator about these fields.\u003c/p\u003e\n\u003cp\u003eAn example here is ECR\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ecr-controller/blob/cefc45b65e1a560b9666a1544f26f955c6f84d36/generator.yaml#L57"\u003e\u003ccode\u003ePullThroughCacheRule\u003c/code\u003e\u003c/a\u003e resource, which \u003ca href="https://docs.aws.amazon.com/AmazonECR/latest/APIReference/API_CreatePullThroughCacheRule.html"\u003ehas a primary key field\u003c/a\u003e called \u003ccode\u003eECRRepositoryPrefix\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n PullThroughCacheRule:\n fields:\n ECRRepositoryPrefix:\n is_primary_key: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003e[NOTE(jljaco): If we discard \u003ccode\u003eis_arn_primary_key\u003c/code\u003e in favor of only \u003ccode\u003eis_primary_key\u003c/code\u003e, this sub-section should be moved into the \u003ccode\u003eField Configuration\u003c/code\u003e section]\u003c/em\u003e\u003c/p\u003e\n\u003ch3 id="exceptions-correcting-exception-codes"\u003e\u003ccode\u003eexceptions\u003c/code\u003e: Correcting exception codes\u003c/h3\u003e\n\u003cp\u003eAn ACK controller needs to understand which HTTP exception code means \u0026ldquo;this resource was not found\u0026rdquo;; otherwise, the controller\u0026rsquo;s logic that determines whether to create or update a resource falls apart.\u003c/p\u003e\n\u003cp\u003eFor the majority of AWS service APIs, the ACK code generator can figure out which HTTP exception codes map to which HTTP fault behaviours. However, some AWS service API model definitions do not include exception metadata. Other service API models include straight-up incorrect information that does not match what the actual AWS service returns.\u003c/p\u003e\n\u003cp\u003eTo address these issues, you can use the \u003ccode\u003eresources[$resource].exceptions\u003c/code\u003e configuration block.\u003c/p\u003e\n\u003cp\u003eAn example of an API model that does not indicate the exception code representing a resource not found is DynamoDB. When calling DynamoDB\u0026rsquo;s \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DescribeTable.html"\u003e\u003ccode\u003eDescribeTable\u003c/code\u003e\u003c/a\u003e API call with a table name that does not exist, you will get back a \u003ccode\u003e400\u003c/code\u003e error code instead of \u003ccode\u003e404\u003c/code\u003e and the exception code string is \u003ccode\u003eResourceNotFoundException\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eTo tell the ACK code generator how to deal with this, use the \u003ccode\u003eexceptions\u003c/code\u003e \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/160b839fe09dd7e1f321e094604ffc3b6ae2a285/pkg/config/resource.go#L251"\u003econfiguration option\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Table:\n exceptions:\n errors:\n 404:\n code: ResourceNotFoundException\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis configuration instructs the code generator to \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/eb1405d3d10050c8a866dc0e2dc0ec72c8213886/pkg/resource/table/sdk.go#L79-L84"\u003eproduce code\u003c/a\u003e that looks for \u003ccode\u003eResourceNotFoundException\u003c/code\u003e in the error response of the API call and interprets it properly as a \u003ccode\u003e404\u003c/code\u003e or \u0026ldquo;resource not found\u0026rdquo; error.\u003c/p\u003e\n\u003ch4 id="terminal_codes-specifying-terminal-codes-to-indicate-terminal-state"\u003e\u003ccode\u003eterminal_codes\u003c/code\u003e: Specifying terminal codes to indicate terminal state\u003c/h4\u003e\n\u003cp\u003eAn \u003ccode\u003eACK.Terminal\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e is placed on a custom resource (inside of its \u003ccode\u003eStatus\u003c/code\u003e) when the controller realizes that, without the user changing the resource\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e, the resource will not be able to be reconciled (i.e., the desired state will never match the actual state).\u003c/p\u003e\n\u003cp\u003eWhen an ACK controller gets a response back from an AWS service containing an error code, the controller evaluates whether that error code should result in the \u003ccode\u003eACK.Terminal\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e being placed on the resource. Examples of these \u0026ldquo;terminal codes\u0026rdquo; are things such as:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eimproper input being supplied\u003c/li\u003e\n\u003cli\u003ea duplicate resource already existing\u003c/li\u003e\n\u003cli\u003econflicting input values\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eAWS service API responses having a \u003ccode\u003e4XX\u003c/code\u003e HTTP status code will have a corresponding exception string code (e.g., \u003ccode\u003eInvalidParameterValue\u003c/code\u003e or \u003ccode\u003eEntityExistsException\u003c/code\u003e). Use the \u003ccode\u003eresources[$resource].exceptions.terminal_codes\u003c/code\u003e configuration option to tell the code generation which of these exception string codes it should consider to be a \u003cem\u003eterminal state\u003c/em\u003e for the resource.\u003c/p\u003e\n\u003cp\u003eHere is \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L97"\u003ean example from the RDS controller\u003c/a\u003e, where we indicate the set of exception string code that will set the resource into a \u003cem\u003eterminal state\u003c/em\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBCluster:\n exceptions:\n terminal_codes:\n - DBClusterQuotaExceededFault\n - DBSubnetGroupDoesNotCoverEnoughAZs\n - InsufficientStorageClusterCapacity\n - InvalidParameter\n - InvalidParameterValue\n - InvalidParameterCombination\n - InvalidSubnet\n - StorageQuotaExceeded\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="reconcile-controlling-reconciliation-and-requeue-logic"\u003e\u003ccode\u003ereconcile\u003c/code\u003e: Controlling reconciliation and requeue logic\u003c/h3\u003e\n\u003cp\u003eBy default, an ACK controller will requeue a resource for future reconciliation only when the resource is in some transitional state.\u003c/p\u003e\n\u003cp\u003eFor example, when you create an RDS \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L184"\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/a\u003e resource, the resource initially goes into a \u003ccode\u003eCREATING\u003c/code\u003e transitional state and then eventually will arrive at an \u003ccode\u003eAVAILABLE\u003c/code\u003e state. When the RDS controller for ACK initially creates the RDS \u003ccode\u003eDBInstance\u003c/code\u003e resource, it calls the RDS \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html"\u003e\u003ccode\u003eCreateDBInstance\u003c/code\u003e\u003c/a\u003e API call, sees the state of the DB instance is \u003ccode\u003eCREATING\u003c/code\u003e, adds an \u003ccode\u003eACK.ResourceSynced=False\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e to the resource and \u003cem\u003erequeues\u003c/em\u003e the resource to be processed again in a few seconds.\u003c/p\u003e\n\u003cp\u003eWhen the resource is processed in the next reconciliation loop, the controller calls the \u003ca href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html"\u003e\u003ccode\u003eDescribeDBInstance\u003c/code\u003e\u003c/a\u003e API endpoint and checks to see if the DB instance is in the \u003ccode\u003eAVAILABLE\u003c/code\u003e state. If it is not, then the controller requeues the resource again. If it is in the \u003ccode\u003eAVAILABLE\u003c/code\u003e state, then the controller sets the \u003ccode\u003eACK.ResourceSynced\u003c/code\u003e \u003ccode\u003eCondition\u003c/code\u003e to \u003ccode\u003eTrue\u003c/code\u003e, which is the indication to the ACK runtime that the resource should \u003cem\u003enot\u003c/em\u003e be requeued.\u003c/p\u003e\n\u003cp\u003eSometimes, you may want to have the ACK controller requeue certain resources \u003cem\u003eeven after a successful reconciliation loop that leaves the resource in the \u003ccode\u003eACK.ResourceSynced=True\u003c/code\u003e state\u003c/em\u003e. If this is the case, you should use the \u003ccode\u003eresources[$resource].reconcile.requeue_on_success_seconds\u003c/code\u003e configuration option. The value of this option should be the amount of time (in seconds) after which the reconciler should requeue the resource.\u003c/p\u003e\n\u003cp\u003eHere is an example of this configuration option as used in the SageMaker controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/sagemaker-controller/blob/c77c6def970cf80322bacaa6aa5ff58dde671dbf/generator.yaml#L595"\u003e\u003ccode\u003eNotebookInstance\u003c/code\u003e resource\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n NotebookInstance:\n # Resource state/status can be modified in Sagemaker Console\n # Need to reconcile to catch these state/status changes\n reconcile: \n requeue_on_success_seconds: 60\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWe set this \u003ccode\u003erequeue_on_success_seconds\u003c/code\u003e value to \u003ccode\u003e60\u003c/code\u003e here because the values of various fields in this Sagemaker resource tend to change often and we want the \u003ccode\u003eStatus\u003c/code\u003e section of our custom resource to contain values that are fresher than the default requeue period (10 hours as of this writing).\u003c/p\u003e\n\u003ch3 id="including-additional-printer-columns"\u003eIncluding additional printer columns\u003c/h3\u003e\n\u003cp\u003e\u003cstrong\u003eTODO(jljaco)\u003c/strong\u003e\u003c/p\u003e\n\u003ch2 id="field-configuration"\u003eField configuration\u003c/h2\u003e\n\u003cp\u003eWhen \u003ccode\u003eack-generate\u003c/code\u003e first \u003ca href="https://aws-controllers-k8s.github.io/community/docs/contributor-docs/api-inference/"\u003einfers the definition of a resource\u003c/a\u003e from the AWS API model, it collects the various member fields of a resource. This documentation section discusses the configuration options that instruct the code generator about a particular resource field.\u003c/p\u003e\n\u003ch3 id="is_read_only-manually-marking-a-field-as-belonging-to-the-resource-status-struct"\u003e\u003ccode\u003eis_read_only\u003c/code\u003e: Manually marking a field as belonging to the resource \u003ccode\u003eStatus\u003c/code\u003e struct\u003c/h3\u003e\n\u003cp\u003eDuring API inference, \u003ccode\u003eack-generate\u003c/code\u003e automatically determines which fields belong in the custom resource definition\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e struct. Fields that can be modified by the user go in the \u003ccode\u003eSpec\u003c/code\u003e and fields that cannot be modified go in the \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].is_read_only\u003c/code\u003e configuration option to override whether a field should go in the \u003ccode\u003eStatus\u003c/code\u003e struct.\u003c/p\u003e\n\u003cp\u003eHere is an example from the Lambda controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/lambda-controller/blob/2ee7a2969ee23c900a18f6265a272669b058b62e/generator.yaml#L52-L53"\u003egenerator.yaml\u003c/a\u003e file that instructs the code generator to treat the \u003ccode\u003eLayerStatuses\u003c/code\u003e field as a read-only field (and thus should belong in the \u003ccode\u003eStatus\u003c/code\u003e struct for the Function resource):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Function:\n fields:\n LayerStatuses:\n is_read_only: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTypically, you will see this configuration option used for fields that have two different Go types representing the modifiable version of the field and the non-modifiable version of the field (as is the case for a Lambda Function\u0026rsquo;s Layers information) or when you need to create a custom field.\u003c/p\u003e\n\u003ch3 id="is_required-marking-a-field-as-required"\u003e\u003ccode\u003eis_required\u003c/code\u003e: Marking a field as required\u003c/h3\u003e\n\u003cp\u003eIf an AWS API model file marks a particular member field as required, \u003ccode\u003eack-generate\u003c/code\u003e will usually infer that the associated custom resource field is required. Sometimes, however, you may want to override whether or not a field should be required. Use the \u003ccode\u003eresources[$resource].fields[$field].is_required\u003c/code\u003e configuration option to do so.\u003c/p\u003e\n\u003cp\u003eHere is an example from the EC2 controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/3b1ba705df02f9b7db1a8079ed7729af7a4f213a/generator.yaml#L206-L209"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file that instructs the code generator to treat the Instance custom resource\u0026rsquo;s MinCount and MaxCount fields as \u003cstrong\u003enot required\u003c/strong\u003e, even though the API model definition marks these fields as required in the Create Operation\u0026rsquo;s Input shape.\u003c/p\u003e\n\u003cp\u003eNOTE: The reason for this is because the EC2 controller only deals with single Instance resources, not batches of instances\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Instance:\n fields:\n MaxCount:\n is_required: false\n MinCount:\n is_required: false\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="type-controlling-a-fields-go-type"\u003e\u003ccode\u003etype\u003c/code\u003e: controlling a field\u0026rsquo;s Go type\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].type\u003c/code\u003e configuration option to override a field\u0026rsquo;s Go type. You will typically use this configuration option for custom fields that are not inferred by \u003ccode\u003eack-generate\u003c/code\u003e by looking at the AWS API model definition.\u003c/p\u003e\n\u003cp\u003eAn example of this is the Policies field for a Role custom resource definition in the IAM controller. The IAM controller uses some custom hook code to allow a Kubernetes user to specify one or more Policy ARNs for a Role simply by specifying \u003ccode\u003eSpec.Policies\u003c/code\u003e. To define this custom field as a list of string pointers, the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/generator.yaml#L164-L168"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file uses the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Role:\n fields:\n # In order to support attaching zero or more policies to a Role, we use\n # custom update code path code that uses the Attach/DetachGroupPolicy API\n # calls to manage the set of PolicyARNs attached to this Role.\n Policies:\n type: \u0026quot;[]*string\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="compare-controlling-how-a-fields-values-are-compared"\u003e\u003ccode\u003ecompare\u003c/code\u003e: Controlling how a field\u0026rsquo;s values are compared\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].compare\u003c/code\u003e configuration option to control how the value of a field is compared between two resources. This configuration option has two boolean subfields, \u003ccode\u003eis_ignored\u003c/code\u003e and \u003ccode\u003enil_equals_zero_value\u003c/code\u003e (TODO(jljaco): \u003ccode\u003enil_equals_zero_value\u003c/code\u003e not yet implemented or used).\u003c/p\u003e\n\u003ch4 id="is_ignored-marking-a-field-as-ignored"\u003e\u003ccode\u003eis_ignored\u003c/code\u003e: marking a field as ignored\u003c/h4\u003e\n\u003cp\u003eUse the \u003ccode\u003eis_ignored\u003c/code\u003e subfield to instruct the code generator to exclude this particular field from automatic value comparisons when building the \u003ccode\u003eDelta\u003c/code\u003e struct that compares two resources.\u003c/p\u003e\n\u003cp\u003eTypically, you will want to mark a field as ignored for comparison operations because the Go type of the field does not natively support deterministic equality operations. For example, a slice of \u003ccode\u003eTag\u003c/code\u003e structs where the code generator does not know how to sort the slice means that the default \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e call will produce non-deterministic results. These types of fields you will want to mark with \u003ccode\u003ecompare.is_ignored: true\u003c/code\u003e and include a custom comparison function using the \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook, \u003ca name="#delta_pre_compare_example_1"\u003e\u003c/a\u003eas this example from the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/generator.yaml#L172-L174"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e does for the Role resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e Role:\n hooks:\n delta_pre_compare:\n code: compareTags(delta, a, b)\n fields:\n Tags:\n compare:\n is_ignored: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="is_immutable-mutable-vs-immutable-fields"\u003e\u003ccode\u003eis_immutable\u003c/code\u003e: Mutable vs. immutable fields\u003c/h3\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].is_immutable\u003c/code\u003e configuration option to mark a field as immutable \u0026ndash; meaning the user cannot update the field after initially setting its value.\u003c/p\u003e\n\u003cp\u003eA good example of the use of \u003ccode\u003eis_immutable\u003c/code\u003e comes from the RDS controller\u0026rsquo;s DBInstance resource\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/generator.yaml#L209-L212"\u003eAvailabilityZone field\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n fields:\n AvailabilityZone:\n late_initialize: {}\n is_immutable: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the case of a DBInstance resource, once the AvailabilityZone field is set by the user, it cannot be modified.\u003c/p\u003e\n\u003cp\u003eBy telling the code generator that this field is immutable, it will generate code in the \u003ccode\u003esdk.go\u003c/code\u003e file that \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/pkg/resource/db_instance/sdk.go#L2768"\u003echecks for whether a user has modified any immutable fields\u003c/a\u003e and set a Condition on the resource if so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// sdkUpdate patches the supplied resource in the backend AWS service API and\n// returns a new resource with updated fields.\nfunc (rm *resourceManager) sdkUpdate(\n ctx context.Context,\n desired *resource,\n latest *resource,\n delta *ackcompare.Delta,\n) (updated *resource, err error) {\n rlog := ackrtlog.FromContext(ctx)\n exit := rlog.Trace(\u0026quot;rm.sdkUpdate\u0026quot;)\n defer func() {\n exit(err)\n }()\n if immutableFieldChanges := rm.getImmutableFieldChanges(delta); len(immutableFieldChanges) \u0026gt; 0 {\n msg := fmt.Sprintf(\u0026quot;Immutable Spec fields have been modified: %s\u0026quot;, strings.Join(immutableFieldChanges, \u0026quot;,\u0026quot;))\n return nil, ackerr.NewTerminalError(fmt.Errorf(msg))\n }\n ...\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="from-controlling-the-source-of-a-fields-definition"\u003e\u003ccode\u003efrom\u003c/code\u003e: Controlling the source of a field\u0026rsquo;s definition\u003c/h3\u003e\n\u003cp\u003eDuring API inference, \u003ccode\u003eack-generate\u003c/code\u003e inspects the AWS service API model definition and discovers resource fields by looking at the Input and Output shapes of the \u003ccode\u003eCreate\u003c/code\u003e API call for that resource. Members of the Input shape will go in the \u003ccode\u003eSpec\u003c/code\u003e and members of the Output shape \u003cem\u003ethat are not also in the Input shape\u003c/em\u003e will go into the \u003ccode\u003eStatus\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eThis works for a majority of the field definitions, however sometimes you want to \u0026ldquo;grab a field\u0026rdquo; from a different location (i.e., other than either the Input or Output shapes of the \u003ccode\u003eCreate\u003c/code\u003e API call).\u003c/p\u003e\n\u003cp\u003eEach Resource typically also has a \u003ccode\u003eReadOne\u003c/code\u003e Operation. The ACK service controller will call this \u003ccode\u003eReadOne\u003c/code\u003e Operation to get the latest observed state of a particular resource in the backend AWS API service. The service controller sets the observed Resource\u0026rsquo;s \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e fields from the Output shape of the \u003ccode\u003eReadOne\u003c/code\u003e Operation. The code generator is responsible for producing the Go code that performs these \u0026ldquo;setter\u0026rdquo; methods on the Resource.\u003c/p\u003e\n\u003cp\u003eThe way the code generator determines how to set the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e fields from the Output shape\u0026rsquo;s member fields is by looking at the data type of the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e field with the same name as the Output shape\u0026rsquo;s member field.\u003c/p\u003e\n\u003cp\u003eImportantly, in producing this \u0026ldquo;setter\u0026rdquo; Go code the code generator \u003cstrong\u003eassumes that the data types (Go types) in the source (the Output shape\u0026rsquo;s member field) and target (the Spec or Status field) are the same\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eThere are some APIs, however, where the Go type of the field in the \u003ccode\u003eCreate\u003c/code\u003e Operation\u0026rsquo;s Input shape is actually different from the same-named field in the \u003ccode\u003eReadOne\u003c/code\u003e Operation\u0026rsquo;s Output shape. A good example of this is the Lambda \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html"\u003e\u003ccode\u003eCreateFunction\u003c/code\u003e\u003c/a\u003e API call, which has a \u003ccode\u003eCode\u003c/code\u003e member of its Input shape that looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e\u0026quot;Code\u0026quot;: {\n \u0026quot;ImageUri\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3Bucket\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3Key\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;S3ObjectVersion\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;ZipFile\u0026quot;: blob\n},\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunction.html"\u003e\u003ccode\u003eGetFunction\u003c/code\u003e\u003c/a\u003e API call\u0026rsquo;s Output shape has a same-named field called \u003ccode\u003eCode\u003c/code\u003e in it, but this field looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e\u0026quot;Code\u0026quot;: {\n \u0026quot;ImageUri\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;Location\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;RepositoryType\u0026quot;: \u0026quot;string\u0026quot;,\n \u0026quot;ResolvedImageUri\u0026quot;: \u0026quot;string\u0026quot;\n},\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis presents a conundrum to the ACK code generator, which, as noted above, assumes the data types of same-named fields in the \u003ccode\u003eCreate\u003c/code\u003e Operation\u0026rsquo;s Input shape and \u003ccode\u003eReadOne\u003c/code\u003e Operation\u0026rsquo;s Output shape are the same.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].from\u003c/code\u003e configuration option to handle these situations.\u003c/p\u003e\n\u003cp\u003eFor the Lambda \u003ccode\u003eFunction\u003c/code\u003e Resource\u0026rsquo;s \u003ccode\u003eCode\u003c/code\u003e field, we can inform the code generator to create three new \u003ccode\u003eStatus\u003c/code\u003e fields (read-only) from the \u003ccode\u003eLocation\u003c/code\u003e, \u003ccode\u003eRepositoryType\u003c/code\u003e and \u003ccode\u003eResolvedImageUri\u003c/code\u003e fields in the \u003ccode\u003eCode\u003c/code\u003e member of the \u003ca href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunction.html"\u003e\u003ccode\u003eReadOne\u003c/code\u003e\u003c/a\u003e Operation\u0026rsquo;s Output shape:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresources:\n Function:\n fields:\n CodeLocation:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.Location\n CodeRepositoryType:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.RepositoryType\n CodeRegisteredImageURI:\n is_read_only: true\n from:\n operation: GetFunction\n path: Code.RegisteredImageUri\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE on maintainability:\u003c/strong\u003e Another way of solving this particular problem would be to use a completely new custom field. However, \u003cem\u003ewe only use this as a last resort\u003c/em\u003e. The reason why we prefer to use the \u003ccode\u003efrom:\u003c/code\u003e configuration option is because this approach will adapt over time with changes to the AWS service API model, including documentation \u003cem\u003eabout\u003c/em\u003e those fields, whereas completely new custom fields will always need to be hand-rolled and no API documentation will be auto-generated for them.\u003c/p\u003e\n\u003ch3 id="print-controlling-a-fields-output-as-printer-columns-in-kubectl-get"\u003e\u003ccode\u003eprint\u003c/code\u003e: Controlling a field\u0026rsquo;s output as printer columns in \u003ccode\u003ekubectl get\u003c/code\u003e\u003c/h3\u003e\n\u003cp\u003eIf we want to add one of a Resource\u0026rsquo;s fields to the output of the \u003ccode\u003ekubectl get\u003c/code\u003e command, we can do so by annotating that field\u0026rsquo;s configuration with a \u003ccode\u003eprint:\u003c/code\u003e section. An example of this is in the EC2 controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L244"\u003e\u003ccode\u003eElasticIPAddress\u003c/code\u003e Resource\u003c/a\u003e, for which we would like to include the \u003ccode\u003ePublicIP\u003c/code\u003e field in the output of \u003ccode\u003ekubectl get\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n ...\n ElasticIPAddress:\n ...\n fields:\n ...\n\u0026gt; PublicIp:\n\u0026gt; print:\n\u0026gt; name: PUBLIC-IP\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIncluding this in the field\u0026rsquo;s configuration will cause the code generator to produce \u003ccode\u003ekubebuilder\u003c/code\u003e markers in the appropriate place in its generated code, which will result in the field being included in the \u003ccode\u003ekubectl get\u003c/code\u003e output.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e this configuration is used to include printer columns in the output at the level of individual fields. One can also create \u003ca href="#including-additional-printer-columns"\u003eadditional printer columns\u003c/a\u003e at the level of Resources.\u003c/p\u003e\n\u003ch3 id="late_initialize-late-initialization-of-a-field"\u003e\u003ccode\u003elate_initialize\u003c/code\u003e: Late initialization of a field\u003c/h3\u003e\n\u003cp\u003e\u003ca href="https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#controller-assigned-defaults-aka-late-initialization"\u003eLate initialization of a field\u003c/a\u003e is a Kubernetes Resource Model concept that allows for a nil-valued field to be defaulted to some value \u003cem\u003eafter the resource has been successfully created\u003c/em\u003e. This is akin to a database table field\u0026rsquo;s \u0026ldquo;default value\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eLate initialized fields are slightly awkward for an ACK controller to handle, primarily because late initialized fields end up being erroneously identified as having different values in the \u003ca href="#the-comparison-hook-points"\u003eDelta comparisons\u003c/a\u003e. The desired state of the field is \u003ccode\u003enil\u003c/code\u003e but the server-side default value of that field is some non-\u003ccode\u003enil\u003c/code\u003e value.\u003c/p\u003e\n\u003cp\u003eACK\u0026rsquo;s code generator can output Go code that handles this server-side defaulting behaviour (we call this \u0026ldquo;late initialization\u0026rdquo;). To instruct the code generator to generate late initialization code for a field, use the \u003ccode\u003eresources[$resource].fields[$field].late_initialize\u003c/code\u003e configuration option.\u003c/p\u003e\n\u003cp\u003eA good example of late initialization can be found in the RDS controller. For \u003ccode\u003eDBInstance\u003c/code\u003e resources, if the user does not specify an availability zone when creating the \u003ccode\u003eDBInstance\u003c/code\u003e, RDS chooses one for the user. To ensure that the RDS controller understands that the \u003ccode\u003eAvailabilityZone\u003c/code\u003e field is set to a default value after creation, the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L211"\u003efollowing configuration\u003c/a\u003e is set in the \u003ccode\u003egenerator.yaml\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n fields:\n AvailabilityZone:\n\u0026gt; late_initialize: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: the \u003ccode\u003elate_initialize:\u003c/code\u003e configuration option is currently a struct with a couple member fields that are not yet implemented (as of Dec 2022), which is why you need to use the \u003ccode\u003e{}\u003c/code\u003e notation.\u003c/p\u003e\n\u003ch3 id="references-making-a-field-refer-to-another-resource"\u003e\u003ccode\u003ereferences\u003c/code\u003e: Making a field refer to another Resource\u003c/h3\u003e\n\u003cp\u003eOne custom resource can refer to another custom resource using something called Resource References. The Go code that handles the validation and resolution of Resource References is generated by \u003ccode\u003eack-generate\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eUse the \u003ccode\u003eresources[$resource].fields[$field].references\u003c/code\u003e configuration option to inform the code generator what \u003cem\u003ekind\u003c/em\u003e of Resource a field references and which \u003cem\u003efield\u003c/em\u003e within that Resource is the identifier field.\u003c/p\u003e\n\u003cp\u003eHere is an example from the API Gateway v2 controller that shows an \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/f94a6ba88adda9790a25540729c89a84f7645ccb/generator.yaml#L63"\u003eIntegration Resource\u003c/a\u003e referencing an API and a VPCLink Resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Integration:\n fields:\n ApiId:\n references:\n resource: API\n path: Status.APIID\n ConnectionId:\n references:\n resource: VPCLink\n path: Status.VPCLinkID\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAfter regenerating the controller, the Integration resource will have two \u003cem\u003enew\u003c/em\u003e fields, one called \u003ccode\u003eAPIRef\u003c/code\u003e and another called \u003ccode\u003eConnectionRef\u003c/code\u003e. The \u003ca href="https://github.com/aws-controllers-k8s/apigatewayv2-controller/blob/5e346c359c25cf29be93b3f3bca30c59cc21a9bf/apis/v1alpha1/integration.go#L26-L31"\u003eGo type of these fields\u003c/a\u003e will be a pointer to an \u003ccode\u003eAWSResourceReferenceWrapper\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003etype IntegrationSpec struct {\n APIID *string `json:\u0026quot;apiID,omitempty\u0026quot;`\n APIRef *ackv1alpha1.AWSResourceReferenceWrapper `json:\u0026quot;apiRef,omitempty\u0026quot;`\n\n ConnectionID *string `json:\u0026quot;connectionID,omitempty\u0026quot;`\n ConnectionRef *ackv1alpha1.AWSResourceReferenceWrapper `json:\u0026quot;connectionRef,omitempty\u0026quot;`\n ...\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: The generated name of the reference fields will always be the field name, stripped of any \u0026ldquo;Id\u0026rdquo;, \u0026ldquo;Name\u0026rdquo;, or \u0026ldquo;ARN\u0026rdquo; suffix, plus \u0026ldquo;Ref\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eIn the above example, both the API and VPCLink Resources are managed by the API Gateway v2 controller. It is possible to reference Resources that are managed by a \u003cem\u003edifferent\u003c/em\u003e ACK controller by specifying the \u003ccode\u003eresources[$resource].fields[$field].references.service_name\u003c/code\u003e configuration option, as shown in this example from the RDS controller, which has the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f8b5d69f822bfc809cbfa25ef7ad60b58a4af22e/generator.yaml#L111-L115"\u003eDBCluster resource reference the KMS controller\u0026rsquo;s Key resource\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBCluster:\n fields:\n KmsKeyId:\n references:\n resource: Key\n service_name: kms\n path: Status.ACKResourceMetadata.ARN\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="adding-custom-fields"\u003eAdding custom fields\u003c/h3\u003e\n\u003cp\u003e\u003ccode\u003eresources[$resource].fields[$field].type\u003c/code\u003e \u003cem\u003eoverrides\u003c/em\u003e the inferred Go type of a field. This is required for custom fields that are not inferred (either as a \u003ccode\u003eCreate\u003c/code\u003e Input/Output shape or via the \u003ccode\u003eSourceFieldConfig\u003c/code\u003e attribute).\u003c/p\u003e\n\u003cp\u003eAs an example, assume you have a \u003ccode\u003eRole\u003c/code\u003e Resource where you want to add a custom \u003ccode\u003eSpec\u003c/code\u003e field called \u003ccode\u003ePolicies\u003c/code\u003e that is a slice of string pointers.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003egenerator.yaml\u003c/code\u003e file for the IAM controller \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L172"\u003elooks like this\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Role:\n fields:\n Policies:\n type: []*string\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThere is no \u003ccode\u003ePolicies\u003c/code\u003e field in either the \u003ccode\u003eCreateRole\u003c/code\u003e Input or Output shapes, therefore in order to create a new custom field, we simply add a \u003ccode\u003ePolicies\u003c/code\u003e object in the \u003ccode\u003efields\u003c/code\u003e configuration mapping and tell the code generator what Go type this new field will have \u0026ndash; in this case, \u003ccode\u003e[]*string\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE on maintainability\u003c/strong\u003e: Use custom fields as a last resort! When you use custom fields, you will not get the benefit of auto-generated documentation for your field like you will with auto-inferred or \u003ccode\u003efrom:\u003c/code\u003e-configured fields. \u003cstrong\u003eYou will be required to use custom code hooks to populate and set any custom fields\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE: (DEPRECATED)\u003c/strong\u003e This can also be accomplished by using \u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L361"\u003e\u003ccode\u003ecustom_field:\u003c/code\u003e\u003c/a\u003e, however we intend to move away from this approach.\u003c/p\u003e\n\u003cp\u003e\u003ca href="https://github.com/aws-controllers-k8s/ec2-controller/blob/b161bb67b0e5d8b24588676ae29d0f1e587bd42a/generator.yaml#L361"\u003eRelevant \u003ccode\u003eTODO\u003c/code\u003e for combining CustomShape stuff into \u003ccode\u003etype:\u003c/code\u003e override\u003c/a\u003e\u003c/p\u003e\n\u003ch2 id="custom-code-hook-points"\u003eCustom code hook points\u003c/h2\u003e\n\u003cp\u003eThe code generator will generate Go code that implements the \u003ccode\u003eaws-sdk-go\u003c/code\u003e SDK \u0026ldquo;binding\u0026rdquo; calls. Sometimes you will want to inject bits of custom code at various points in the code generation pipeline.\u003c/p\u003e\n\u003cp\u003eCustom code \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/160b839fe09dd7e1f321e094604ffc3b6ae2a285/pkg/generate/ack/hook.go#L28"\u003ehook points\u003c/a\u003e do this injection. They should be preferred versus using complete overrides (e.g., \u003ccode\u003eresources[$resource].update_operation.custom_method_name\u003c/code\u003e). The reason that custom code hooks are preferred is because you generally want to maximize the amount of \u003cem\u003egenerated\u003c/em\u003e code and minimize the amount of \u003cem\u003ehand-written\u003c/em\u003e code in each controller. \u003cem\u003e[NOTE(jljaco): decide later whether to bother documenting complete overrides via \u003ccode\u003eupdate_operation.custom_method_name\u003c/code\u003e]\u003c/em\u003e\u003c/p\u003e\n\u003ch3 id="the-sdkgo-hook-points"\u003eThe \u003ccode\u003esdk.go\u003c/code\u003e hook points\u003c/h3\u003e\n\u003cp\u003eFirst, some background. Within the \u003ccode\u003epkg/resources/$resource/sdk.go\u003c/code\u003e file, there are 4 primary resource manager methods that control CRUD operations on a resource:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003esdkFind\u003c/code\u003e reads a single resource record from a backend AWS service API, then populates a custom resource representation of that record and returns it back to the reconciler.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkCreate\u003c/code\u003e takes the desired custom resource state (in the \u003ccode\u003eSpec\u003c/code\u003e struct of the CR). It calls AWS service APIs to create the resource in AWS, then sets certain fields on the custom resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct that represent the latest observed state of that resource.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkUpdate\u003c/code\u003e takes the desired custom resource state (from the \u003ccode\u003eSpec\u003c/code\u003e struct of the CR), the latest observed resource state, and a representation of the differences between those (called a \u003ccode\u003eDelta\u003c/code\u003e struct). It calls one or more AWS service APIs to modify a resource\u0026rsquo;s attributes, then populates the custom resource\u0026rsquo;s \u003ccode\u003eStatus\u003c/code\u003e struct with the latest (post-modification) observed state of the resource.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003esdkDelete\u003c/code\u003e calls one or more AWS service APIs to delete a resource.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor all 4 of these main ResourceManager methods, there is a consistent code path that looks like this:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003cstrong\u003eConstruct the SDK Input shape\u003c/strong\u003e. For \u003ccode\u003esdkFind\u003c/code\u003e and \u003ccode\u003esdkDelete\u003c/code\u003e, this Input shape will contain the identifier of the resource (e.g. an \u003ccode\u003eARN\u003c/code\u003e). For \u003ccode\u003esdkCreate\u003c/code\u003e and \u003ccode\u003esdkUpdate\u003c/code\u003e, this Input shape will also contain various desired state fields for the resource. This is called the \u0026ldquo;\u003cstrong\u003eSet SDK\u003c/strong\u003e\u0026rdquo; stage and corresponds to code generator functions in code-generator\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/generate/code/set_sdk.go"\u003e\u003ccode\u003epkg/generate/code/set_sdk.go\u003c/code\u003e\u003c/a\u003e.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003ePass the SDK Input shape\u003c/strong\u003e to the \u003ccode\u003eaws-sdk-go\u003c/code\u003e API method.\n\u003cul\u003e\n\u003cli\u003eFor \u003ccode\u003esdkFind\u003c/code\u003e, this API method will be \u003cem\u003eeither\u003c/em\u003e the \u003ccode\u003eReadOne\u003c/code\u003e operation for the resource (e.g., ECR\u0026rsquo;s \u003ccode\u003eGetRepository\u003c/code\u003e or RDS\u0026rsquo;s \u003ccode\u003eDescribeDBInstance\u003c/code\u003e) or the \u003ccode\u003eReadMany\u003c/code\u003e operation (e.g., S3\u0026rsquo;s \u003ccode\u003eListBuckets\u003c/code\u003e or EC2\u0026rsquo;s \u003ccode\u003eDescribeInstances\u003c/code\u003e).\u003c/li\u003e\n\u003cli\u003eFor the \u003ccode\u003esdkCreate\u003c/code\u003e, \u003ccode\u003esdkUpdate\u003c/code\u003e and \u003ccode\u003esdkDelete\u003c/code\u003e methods, the API operation will correspond to the \u003ccode\u003eCreate\u003c/code\u003e, \u003ccode\u003eUpdate\u003c/code\u003e and \u003ccode\u003eDelete\u003c/code\u003e operation types.\u003c/li\u003e\n\u003c/ul\u003e\n\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eProcess the error/return code\u003c/strong\u003e from the API call. If there is an error that appears in the list of Terminal codes (\u003cstrong\u003eTODO(jljaco) link to docs\u003c/strong\u003e), then the custom resource will have a Terminal condition applied to it, and a Terminal error is returned to the reconciler. The reconciler will subsequently add a \u003ccode\u003eACK.Terminal\u003c/code\u003e Condition to the custom resource.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eProcess the Output shape\u003c/strong\u003e from the API call. If no error was returned from the API call, the Output shape representing the HTTP response content will then be processed, resulting in fields in either the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e of the custom resource being set to the value of matching fields on the Output shape. This is called the \u0026ldquo;\u003cstrong\u003eSet Resource\u003c/strong\u003e\u0026rdquo; stage and corresponds to code generator functions in code-generator\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/code-generator/blob/main/pkg/generate/code/set_resource.go"\u003e\u003ccode\u003epkg/generate/code/set_resource.go\u003c/code\u003e\u003c/a\u003e.\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eAlong with the above 4 main ResourceManager methods, there are a number of generated helper methods and functions that will:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003ecreate the SDK input shape used when making HTTP requests to AWS APIs\u003c/li\u003e\n\u003cli\u003eprocess responses from those AWS APIs\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch4 id="sdk__pre_build_request-before-validation-and-construction-of-input-shape"\u003e\u003ccode\u003esdk_*_pre_build_request\u003c/code\u003e: before validation and construction of Input shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003esdk_*_pre_build_request\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e the call to construct the Input shape that is used in the API operation and therefore \u003cem\u003ebefore\u003c/em\u003e any call to validate that Input shape.\u003c/p\u003e\n\u003cp\u003eUse this custom hook point if you want to short-circuit the processing of the resource for some reason \u003cstrong\u003eOR\u003c/strong\u003e if you want to process certain resource fields (e.g., Tags) separately from the main resource fields.\u003c/p\u003e\n\u003ch5 id="example-short-circuiting"\u003eExample: Short-circuiting\u003c/h5\u003e\n\u003cp\u003eHere is an example from the DynamoDB controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/ce5980c26538b0d9310a2526a845a77da2d2f611/generator.yaml#L1"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file that uses a \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/ce5980c26538b0d9310a2526a845a77da2d2f611/generator.yaml#L36"\u003e\u003ccode\u003epre_build_request\u003c/code\u003e\u003c/a\u003e custom code hook for Table resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Table:\n hooks:\n sdk_delete_pre_build_request:\n template_path: hooks/table/sdk_delete_pre_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, the hook is for the Delete operation. You can specify the filepath to a template which contains Go code that you wish to inject at this custom hook point. Here is the \u003ca href="https://github.com/aws-controllers-k8s/dynamodb-controller/blob/1e4563776d5efe9455cb7a347d73cc298f6f16b9/templates/hooks/table/sdk_delete_pre_build_request.go.tpl#L0-L1"\u003eGo code from that template\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e if isTableDeleting(r) {\n return nil, requeueWaitWhileDeleting\n }\n if isTableUpdating(r) {\n return nil, requeueWaitWhileUpdating\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe snippet of Go code above simply requeues the resource to be deleted in the future if the Table is currently either being updated (via \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateTable.html"\u003e\u003ccode\u003eUpdateTable\u003c/code\u003e\u003c/a\u003e) or deleted (via \u003ca href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_DeleteTable.html"\u003e\u003ccode\u003eDeleteTable\u003c/code\u003e\u003c/a\u003e).\u003c/p\u003e\n\u003cp\u003eAfter running \u003ccode\u003emake build-controller\u003c/code\u003e for DynamoDB, the above \u003ccode\u003egenerator.yaml\u003c/code\u003e configuration and corresponding template file produces the following Go code implementation for \u003ccode\u003esdkDelete\u003c/code\u003e inside of the \u003ccode\u003esdk.go\u003c/code\u003e file for Table resources:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// sdkDelete deletes the supplied resource in the backend AWS service API\nfunc (rm *resourceManager) sdkDelete(\n ctx context.Context,\n r *resource,\n) (latest *resource, err error) {\n rlog := ackrtlog.FromContext(ctx)\n exit := rlog.Trace(\u0026quot;rm.sdkDelete\u0026quot;)\n defer func() {\n exit(err)\n }()\n\u0026gt; if isTableDeleting(r) {\n\u0026gt; return nil, requeueWaitWhileDeleting\n\u0026gt; }\n\u0026gt; if isTableUpdating(r) {\n\u0026gt; return nil, requeueWaitWhileUpdating\n\u0026gt; }\n input, err := rm.newDeleteRequestPayload(r)\n if err != nil {\n return nil, err\n }\n var resp *svcsdk.DeleteTableOutput\n _ = resp\n resp, err = rm.sdkapi.DeleteTableWithContext(ctx, input)\n rm.metrics.RecordAPICall(\u0026quot;DELETE\u0026quot;, \u0026quot;DeleteTable\u0026quot;, err)\n return nil, err\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIn the example above, we\u0026rsquo;ve highlighted the lines (with \u003ccode\u003e\u0026gt;\u003c/code\u003e) that were injected into the \u003ccode\u003esdkDelete\u003c/code\u003e method using this custom hook point.\u003c/p\u003e\n\u003ch5 id="example-custom-field-processing"\u003eExample: Custom field processing\u003c/h5\u003e\n\u003cp\u003eAnother example of a \u003ccode\u003epre_build_request\u003c/code\u003e custom hook comes from the IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L122"\u003eRole resource\u003c/a\u003e and this \u003ccode\u003egenerator.yaml\u003c/code\u003e snippet:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n Role:\n hooks:\n sdk_update_pre_build_request:\n template_path: hooks/role/sdk_update_pre_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003ewhich has the following \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L122"\u003eGo code in the template file\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e if delta.DifferentAt(\u0026quot;Spec.Policies\u0026quot;) {\n err = rm.syncPolicies(ctx, desired, latest)\n if err != nil {\n return nil, err\n }\n }\n if delta.DifferentAt(\u0026quot;Spec.Tags\u0026quot;) {\n err = rm.syncTags(ctx, desired, latest)\n if err != nil {\n return nil, err\n }\n }\n if delta.DifferentAt(\u0026quot;Spec.PermissionsBoundary\u0026quot;) {\n err = rm.syncRolePermissionsBoundary(ctx, desired)\n if err != nil {\n return nil, err\n }\n }\n if !delta.DifferentExcept(\u0026quot;Spec.Tags\u0026quot;, \u0026quot;Spec.Policies\u0026quot;, \u0026quot;Spec.PermissionsBoundary\u0026quot;) {\n return desired, nil\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWhat you can see above is the use of the \u003ccode\u003epre_build_request\u003c/code\u003e hook point to update the Role\u0026rsquo;s policy collection, tag collection, and permissions boundary \u003cem\u003ebefore\u003c/em\u003e calling the \u003ccode\u003eUpdateRole\u003c/code\u003e API call. The reason for this is because a Role\u0026rsquo;s policies, tags, and permissions boundary are set using a different set of AWS API calls.\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003eTOP TIP (1)\u003c/strong\u003e:\nNote the use of \u003ccode\u003edelta.DifferentAt()\u003c/code\u003e in the code above. This is the recommended best practice for determining whether a particular field at a supplied field path has diverged between the desired and latest observed resource state.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003ch4 id="sdk__post_build_request-after-construction-of-input-shape"\u003e\u003ccode\u003esdk_*_post_build_request\u003c/code\u003e: after construction of Input shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_build_request\u003c/code\u003e hooks are called AFTER the call to construct the Input shape but \u003cem\u003ebefore\u003c/em\u003e the API operation.\u003c/p\u003e\n\u003cp\u003eUse this custom hook point if you want to add custom validation of the Input shape.\u003c/p\u003e\n\u003cp\u003eHere\u0026rsquo;s an example of a \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/f97b026cdd72e222390f42a18770fb0de49c3b41/generator.yaml#L196"\u003e\u003ccode\u003epost_build_request\u003c/code\u003e custom hook point\u003c/a\u003e from the RDS controller\u0026rsquo;s DBInstance resource:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml="\u003eresources:\n DBInstance:\n hooks:\n sdk_update_post_build_request:\n template_path: hooks/db_instance/sdk_update_post_build_request.go.tpl\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eand here\u0026rsquo;s the \u003ca href="https://github.com/aws-controllers-k8s/rds-controller/blob/b0d7dadfce38d293df637b24479ac0a85c764ad9/templates/hooks/db_instance/sdk_update_post_build_request.go.tpl#L0-L1"\u003eGo code in that template\u003c/a\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e // ModifyDBInstance call will return ValidationError when the\n // ModifyDBInstanceRequest contains the same DBSubnetGroupName\n // as the DBInstance. So, if there is no delta between\n // desired and latest for Spec.DBSubnetGroupName, exclude it\n // from ModifyDBInstanceRequest\n if !delta.DifferentAt(\u0026quot;Spec.DBSubnetGroupName\u0026quot;) {\n input.DBSubnetGroupName = nil\n }\n\n // RDS will not compare diff value and accept any modify db call\n // for below values, MonitoringInterval, CACertificateIdentifier\n // and user master password, NetworkType\n // hence if there is no delta between desired\n // and latest, exclude it from ModifyDBInstanceRequest\n if !delta.DifferentAt(\u0026quot;Spec.MonitoringInterval\u0026quot;) {\n input.MonitoringInterval = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.CACertificateIdentifier\u0026quot;) {\n input.CACertificateIdentifier = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.MasterUserPassword.Name\u0026quot;) {\n input.MasterUserPassword = nil\n }\n if !delta.DifferentAt(\u0026quot;Spec.NetworkType\u0026quot;) {\n input.NetworkType = nil\n }\n\n // For dbInstance inside dbCluster, it\'s either aurora or\n // multi-az cluster case, in either case, the below params\n // are not controlled in instance level.\n // hence when DBClusterIdentifier appear, set them to nil\n // Please refer to doc : https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DeleteDBInstance.html\n if desired.ko.Spec.DBClusterIdentifier != nil {\n input.AllocatedStorage = nil\n input.BackupRetentionPeriod = nil\n input.PreferredBackupWindow = nil\n input.DeletionProtection = nil\n }\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eAs you can see, we add some custom validation and normalization of the Input shape for a DBInstance before calling the \u003ccode\u003eModifyDBInstance\u003c/code\u003e API call.\u003c/p\u003e\n\u003cblockquote\u003e\n\u003cp\u003e\u003cstrong\u003eTOP TIP (2)\u003c/strong\u003e:\nNote the verbose usage of nil-checks. \u003cstrong\u003e\u003cem\u003eThis is very important\u003c/em\u003e\u003c/strong\u003e. \u003ccode\u003eaws-sdk-go\u003c/code\u003e does not have automatic protection against \u003ccode\u003enil\u003c/code\u003e pointer dereferencing. \u003cem\u003eAll\u003c/em\u003e fields in an \u003ccode\u003eaws-sdk-go\u003c/code\u003e shape are \u003cstrong\u003epointer types\u003c/strong\u003e. This means you should \u003cstrong\u003ealways\u003c/strong\u003e do your own nil-checks when dereferencing \u003cstrong\u003eany\u003c/strong\u003e field in \u003cstrong\u003eany\u003c/strong\u003e shape.\u003c/p\u003e\n\u003c/blockquote\u003e\n\u003ch4 id="sdk__post_request-after-the-api-operation"\u003e\u003ccode\u003esdk_*_post_request\u003c/code\u003e: after the API operation\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_request\u003c/code\u003e hooks are called IMMEDIATELY AFTER the API operation \u003ccode\u003eaws-sdk-go\u003c/code\u003e client call. These hooks will have access to a Go variable named \u003ccode\u003eresp\u003c/code\u003e that refers to the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client response and a Go variable named \u003ccode\u003erespErr\u003c/code\u003e that refers to any error returned from the \u003ccode\u003eaws-sdk-go\u003c/code\u003e client call.\u003c/p\u003e\n\u003ch4 id="sdk__pre_set_output-before-validation-of-output-shape"\u003e\u003ccode\u003esdk_*_pre_set_output\u003c/code\u003e: before validation of Output shape\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epre_set_output\u003c/code\u003e hooks are called BEFORE the code that processes the Output shape (the \u003ccode\u003epkg/generate/code.SetOutput\u003c/code\u003e function). These hooks will have access to a Go variable named \u003ccode\u003eko\u003c/code\u003e that represents the concrete Kubernetes CR object that will be returned from the main method (\u003ccode\u003esdkFind\u003c/code\u003e, \u003ccode\u003esdkCreate\u003c/code\u003e, etc). This \u003ccode\u003eko\u003c/code\u003e variable will have been defined immediately before the \u003ccode\u003epre_set_output\u003c/code\u003e hooks as a copy of the resource that is supplied to the main method, like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go"\u003e // Merge in the information we read from the API call above to the copy of\n // the original Kubernetes object we passed to the function\n ko := r.ko.DeepCopy()\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="sdk__post_set_output-after-merging-data-from-api-response--k8s-object"\u003e\u003ccode\u003esdk_*_post_set_output\u003c/code\u003e: after merging data from API response \u0026amp; k8s object\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003epost_set_output\u003c/code\u003e hooks are called AFTER the the information from the API call is merged with the copy of the original Kubernetes object. These hooks will have access to the updated Kubernetes object \u003ccode\u003eko\u003c/code\u003e, the response of the API call (and the original Kubernetes CR object if it\u0026rsquo;s \u003ccode\u003esdkUpdate\u003c/code\u003e).\u003c/p\u003e\n\u003ch4 id="sdk_file_end--miscellaneous-catch-all"\u003e\u003ccode\u003esdk_file_end\u003c/code\u003e: miscellaneous catch-all\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003esdk_file_end\u003c/code\u003e is a generic hook point that occurs outside the scope of any specific \u003ccode\u003eAWSResourceManager\u003c/code\u003e method and can be used to place commonly-generated code inside the \u003ccode\u003esdk.go\u003c/code\u003e file.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003e\u003cem\u003eNOTE(jaypipes): This is the weirdest of the hooks\u0026hellip; need to cleanly explain this!\u003c/em\u003e\u003c/strong\u003e\u003c/p\u003e\n\u003ch3 id="the-comparison-hook-points"\u003eThe comparison hook points\u003c/h3\u003e\n\u003ch4 id="delta_pre_compare-before-comparing-resources"\u003e\u003ccode\u003edelta_pre_compare\u003c/code\u003e: before comparing resources\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003edelta_pre_compare\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e the generated code that compares two resources.\u003c/p\u003e\n\u003cp\u003e\u003cstrong\u003eNOTE\u003c/strong\u003e: If you specified that a particular field should have its \u003cstrong\u003ecomparison code ignored\u003c/strong\u003e, you almost always will want to use a \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook to handle the comparison logic for that field. See the \u003ca href="#delta_pre_compare_example_1"\u003eexample above\u003c/a\u003e in the section on \u0026ldquo;\u003cem\u003eMarking a field as ignored\u003c/em\u003e\u0026rdquo; for an illustration of this.\u003c/p\u003e\n\u003cp\u003eThe canonical example of when and how to use this custom code hook point is for handling the correct comparison of slices of Tag structs.\u003c/p\u003e\n\u003cp\u003eBy default, if the code generator does not know how to generate specialized comparison code for a Go type, it will generate a call to \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e for this comparison. However, for some types (e.g., lists-of-structs), \u003ccode\u003ereflect.DeepEqual\u003c/code\u003e will return \u003ccode\u003etrue\u003c/code\u003e \u003cem\u003eeven when the only difference between two lists lies in the order by which the structs are sorted\u003c/em\u003e. This sort order needs to be ignored in order that the comparison logic properly returns \u003ccode\u003efalse\u003c/code\u003e for lists-of-structs that are identical regardless of sort order.\u003c/p\u003e\n\u003cp\u003eThe IAM controller\u0026rsquo;s \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/3f60454e25ce47c050d429773aa826253bb21507/generator.yaml#L124"\u003e\u003ccode\u003egenerator.yaml\u003c/code\u003e\u003c/a\u003e file contains this snippet:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e Role:\n hooks:\n delta_pre_compare:\n code: compareTags(delta, a, b)\n fields:\n Tags:\n compare:\n is_ignored: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eand the \u003ccode\u003edelta_pre_compare\u003c/code\u003e hook code is an inline Go code function call to \u003ccode\u003ecompareTags\u003c/code\u003e. This function is \u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/pkg/resource/role/hooks.go#L188-L202"\u003edefined in the \u003ccode\u003ehooks.go\u003c/code\u003e file\u003c/a\u003e for the Role resource and looks like this:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-go="\u003e// compareTags is a custom comparison function for comparing lists of Tag\n// structs where the order of the structs in the list is not important.\nfunc compareTags(\n delta *ackcompare.Delta,\n a *resource,\n b *resource,\n) {\n if len(a.ko.Spec.Tags) != len(b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n } else if len(a.ko.Spec.Tags) \u0026gt; 0 {\n if !commonutil.EqualTags(a.ko.Spec.Tags, b.ko.Spec.Tags) {\n delta.Add(\u0026quot;Spec.Tags\u0026quot;, a.ko.Spec.Tags, b.ko.Spec.Tags)\n }\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003ca href="https://github.com/aws-controllers-k8s/iam-controller/blob/b6a62ca48c1aea7ab78e62fb3ad6845335c1f1c2/pkg/util/tags.go#L22-L59"\u003e\u003ccode\u003ecommonutil.EqualTags\u003c/code\u003e\u003c/a\u003e properly handles the comparison of lists of Tag structs.\u003c/p\u003e\n\u003ch4 id="delta_post_compare-after-comparing-resources"\u003e\u003ccode\u003edelta_post_compare\u003c/code\u003e: after comparing resources\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003edelta_post_compare\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e the generated code that compares two resources.\u003c/p\u003e\n\u003cp\u003eThis hook is not commonly used, since the \u003ccode\u003edelta_pre_compare\u003c/code\u003e custom code hook point is generally used to inject custom code for comparing special fields.\u003c/p\u003e\n\u003cp\u003eHowever, the \u003ccode\u003edelta_post_compare\u003c/code\u003e hook point can be useful if you want to add some code that can post-process the Delta struct \u003cem\u003eafter all fields\u003c/em\u003e have been compared. For example, if you wanted to output some debugging information about the comparison operations.\u003c/p\u003e\n\u003ch3 id="the-late-initialization-hook-points"\u003eThe late initialization hook points\u003c/h3\u003e\n\u003ch4 id="late_initialize_pre_read_one-before-the-readone"\u003e\u003ccode\u003elate_initialize_pre_read_one\u003c/code\u003e: before the \u003ccode\u003ereadOne\u003c/code\u003e\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003elate_initialize_pre_read_one\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e making the \u003ccode\u003ereadOne\u003c/code\u003e call inside the \u003ccode\u003eAWSResourceManager.LateInitialize()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="late_initialize_post_read_one-after-the-readone"\u003e\u003ccode\u003elate_initialize_post_read_one\u003c/code\u003e: after the \u003ccode\u003ereadOne\u003c/code\u003e\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003elate_initialize_post_read_one\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e making the \u003ccode\u003ereadOne\u003c/code\u003e call inside the \u003ccode\u003eAWSResourceManager.LateInitialize()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch3 id="the-reference-hook-points"\u003eThe reference hook points\u003c/h3\u003e\n\u003ch4 id="references_pre_resolve-before-resolving-references"\u003e\u003ccode\u003ereferences_pre_resolve\u003c/code\u003e: before resolving references\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003ereferences_pre_resolve\u003c/code\u003e hook is called \u003cem\u003ebefore\u003c/em\u003e resolving the references for all Reference fields inside the \u003ccode\u003eAWSResourceManager.ResolveReferences()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="references_post_resolve-after-resolving-references"\u003e\u003ccode\u003ereferences_post_resolve\u003c/code\u003e: after resolving references\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003ereferences_post_resolve\u003c/code\u003e hook is called \u003cem\u003eafter\u003c/em\u003e resolving the references for all Reference fields inside the \u003ccode\u003eAWSResourceManager.ResolveReferences()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch3 id="the-tags-hook-points"\u003eThe tags hook points\u003c/h3\u003e\n\u003ch4 id="ensure_tags-custom-ensuretags-method"\u003e\u003ccode\u003eensure_tags\u003c/code\u003e: custom \u003ccode\u003eEnsureTags\u003c/code\u003e method\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003eensure_tags\u003c/code\u003e hook provides a complete custom implementation for the \u003ccode\u003eAWSResourceManager.EnsureTags()\u003c/code\u003e method.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags-custom-toacktags-and-fromacktags-methods"\u003e\u003ccode\u003econvert_tags\u003c/code\u003e: custom \u003ccode\u003eToACKTags\u003c/code\u003e and \u003ccode\u003eFromACKTags\u003c/code\u003e methods\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags\u003c/code\u003e hook provides a complete custom implementation for the \u003ccode\u003eToACKTags\u003c/code\u003e and \u003ccode\u003eFromACKTags\u003c/code\u003e methods.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_pre_to_ack_tags-before-converting-k8s-tags-to-ack-tags"\u003e\u003ccode\u003econvert_tags_pre_to_ack_tags\u003c/code\u003e: before converting k8s tags to ACK tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_pre_to_ack_tags\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e converting the K8s resource tags into ACK tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_post_to_ack_tags-after-converting-k8s-tags-to-ack-tags"\u003e\u003ccode\u003econvert_tags_post_to_ack_tags\u003c/code\u003e: after converting k8s tags to ACK tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_post_to_ack_tags\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e converting the K8s resource tags into ACK tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_pre_from_ack_tags-before-converting-ack-tags-to-k8s-tags"\u003e\u003ccode\u003econvert_tags_pre_from_ack_tags\u003c/code\u003e: before converting ACK tags to k8s tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_pre_from_ack_tags\u003c/code\u003e hooks are called \u003cem\u003ebefore\u003c/em\u003e converting the ACK tags into K8s resource tags.\nTODO\u003c/p\u003e\n\u003ch4 id="convert_tags_post_from_ack_tags-after-converting-ack-tags-to-k8s-tags"\u003e\u003ccode\u003econvert_tags_post_from_ack_tags\u003c/code\u003e: after converting ACK tags to k8s tags\u003c/h4\u003e\n\u003cp\u003eThe \u003ccode\u003econvert_tags_post_from_ack_tags\u003c/code\u003e hooks are called \u003cem\u003eafter\u003c/em\u003e converting the ACK tags into K8s resource tags.\nTODO\u003c/p\u003e\n\u003ch2 id="attribute-based-apis"\u003eAttribute-based APIs\u003c/h2\u003e\n\u003cp\u003e\u003cstrong\u003eOMG TODO.\u003c/strong\u003e\u003c/p\u003e\n\u003ch2 id="miscellaneousmaybe-cover-laterdocumentation-backlog"\u003eMiscellaneous/maybe cover later/documentation backlog\u003c/h2\u003e\n\u003ch3 id="what-does-prefixconfig-do"\u003eWhat does PrefixConfig do?\u003c/h3\u003e\n\u003ch3 id="what-if-the-code-generator-cannot-figure-out-my-services-api-model-name"\u003eWhat if the code generator cannot figure out my service\u0026rsquo;s API model name?\u003c/h3\u003e\n\u003ch3 id="list_operationmatch_fields"\u003elist_operation.match_fields\u003c/h3\u003e\n'}).add({id:34,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/leader-election/",title:"Managing multiple instances of ACK with leader election",description:"Configure leader election for ACK controllers",content:'\u003cp\u003eIn a Kubernetes cluster, you may want to run multiple instances of any ACK\ncontroller - configured for different accounts or regions, or for fail state\nrollover.\nHowever, to avoid conflicts and ensure proper resource management, it\u0026rsquo;s necessary\nto designate one instance as the leader, which takes responsibility for executing\ncertain operations while the other instances remain passive. In the event that\nthe leader instance fails, \u003ca href="https://kubernetes.io/docs/concepts/architecture/leases/#leader-election"\u003eleader election\u003c/a\u003e ensures the seamless\ntransition of leadership to another healthy instance.\u003c/p\u003e\n\u003cp\u003eBy default, leader election is disabled in the ACK Helm charts. However, once\nenabled, you gain the flexibility to scale the default deployment of ACK controllers\nfrom a single replica (1) to a higher number.\u003c/p\u003e\n\u003ch2 id="enabling-leader-election-for-ack-controllers"\u003eEnabling Leader Election for ACK Controllers\u003c/h2\u003e\n\u003cp\u003eTo enable leader election when installing an ACK controller, set the\n\u003ccode\u003eleaderElection.enabled\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e in the helm chart \u003ccode\u003evalues.yaml\u003c/code\u003e like:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eleaderElection:\n enabled: true\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou also have the flexibility to scale the number of controller replicas. Edit\nthe \u003ccode\u003edeployment.replicas\u003c/code\u003e configuration in the same \u003ccode\u003evalues.yaml\u003c/code\u003e file and\nadjust it to your desired count, such as:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeployment:\n replicas: 3\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="configuring-leader-election-namespace"\u003eConfiguring Leader Election \u003ccode\u003eNamespace\u003c/code\u003e\u003c/h2\u003e\n\u003cp\u003eThe leader election namespace is a controller configuration setting that\ndetermines the namespace where controllers manage leader election. Under the\nhood it is used for storing \u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e objects, which help\ncontrollers reach consensus and choose a leader. If not specified, the system\nwill use the namespace from the service account\u0026rsquo;s configuration by default.\u003c/p\u003e\n\u003cp\u003eIf you would like to set leader election namespace for your ACK controllers,\nyou need to set \u003ccode\u003eleaderElection.namespace\u003c/code\u003e, like below:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eleaderElection:\n enabled: true\n namespace: \u0026quot;ack-leader-election-ns\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="verifying-leader-election"\u003eVerifying Leader Election\u003c/h2\u003e\n\u003cp\u003eTo confirm that leader election is active, you can perform the following checks:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003cstrong\u003eLog Messages\u003c/strong\u003e: Examine the logs of your ACK controller pods for any messages\nindicating the successful execution of leader election.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003e\u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e Objects\u003c/strong\u003e: You can also inspect the\n\u003ccode\u003ecoordination.k8s.io/lease\u003c/code\u003e objects within the configured leader election\nnamespace. Using \u003ccode\u003ekubectl\u003c/code\u003e you can retrieve information about these objects,\nallowing you to verify leadership status.\u003c/li\u003e\n\u003cli\u003e\u003cstrong\u003eKubernetes Events\u003c/strong\u003e: Another method is to monitor Kubernetes events related to your\ncontrollers. Execute \u003ccode\u003ekubectl get events\u003c/code\u003e to view events that might provide insights\ninto leader election and controller behavior.\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:35,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/authorization/",title:"Permissions Overview",description:"Configuring RBAC and IAM for ACK",content:'\u003cp\u003eThere are two different Role-Based Access Control (RBAC) systems needed for ACK service controller authorization: Kubernetes RBAC and AWS IAM.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThis guide is only informative. You do not need to execute any commands from this page.\u003c/p\u003e\n\u003cp\u003eKubernetes RBAC permissions below are already handled when you install ACK service\ncontroller using \u003ca href="../install"\u003eHelm chart or static manifests\u003c/a\u003e\u003c/p\u003e\n\u003cp\u003eAWS IAM permissions are handled using the IAM role created during \u003ca href="../irsa"\u003eIRSA setup\u003c/a\u003e\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003e\u003ca href="https://kubernetes.io/docs/reference/access-authn-authz/rbac/"\u003eKubernetes RBAC\u003c/a\u003e governs a Kubernetes user\u0026rsquo;s ability to read or write Kubernetes resources, while \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html"\u003eAWS Identity and Access Management\u003c/a\u003e (IAM) policies govern the ability of an AWS IAM role to read or write AWS resources.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n These two RBAC systems to not overlap\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The Kubernetes user that makes a Kubernetes API call with \u003ccode\u003ekubectl\u003c/code\u003e has no\nassociation with an IAM role. Instead, the IAM role is associated with the\n\u003ca href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/"\u003eservice account\u003c/a\u003e\nthat runs the ACK service controller\u0026rsquo;s pod.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eRefer to the following diagram for more details on running a Kubernetes API server with RBAC authorization mode enabled.\u003c/p\u003e\n\u003cp\u003e\u003cimg src="../images/authorization.png" alt="Authorization in ACK"\u003e\u003c/p\u003e\n\u003cp\u003eYou will need to configure Kubernetes RBAC and AWS IAM permissions before using ACK service controllers.\u003c/p\u003e\n\u003ch2 id="kubernetes-rbac"\u003eKubernetes RBAC\u003c/h2\u003e\n\u003ch3 id="permissions-required-for-the-ack-service-controller"\u003ePermissions required for the ACK service controller\u003c/h3\u003e\n\u003cp\u003eACK service controllers may be started in either \u003cem\u003eCluster Mode\u003c/em\u003e or \u003cem\u003eNamespace\nMode\u003c/em\u003e. Controllers started in Cluster Mode watch for new, updated and deleted\ncustom resources (CRs) in all Kubernetes \u003ccode\u003eNamespaces\u003c/code\u003e. Conversely, controllers\nstarted in Namespace Mode only watch for CRs in a single Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e\nidentified by the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003ch4 id="namespace-mode"\u003eNamespace Mode\u003c/h4\u003e\n\u003cp\u003eWhen a service controller is started in Namespace Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e\nflag is supplied and the controller will \u003cem\u003eonly\u003c/em\u003e watch for custom resources\n(CRs) in that Kubernetes Namespace.\u003c/p\u003e\n\u003cp\u003eControllers started in Namespace Mode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the controller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eRole\u003c/code\u003e with\npermissions to create, update/patch, delete, read, list and watch ACK custom\nresources matching the associated AWS service in the specific Kubernetes\n\u003ccode\u003eNamespace\u003c/code\u003e identified by the \u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n The \u003ccode\u003einstallScope: namespace\u003c/code\u003e Helm Chart value\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you are installing an ACK service controller via the associated Helm Chart,\nyou can simplify a Namespace Mode installation by setting the \u003ccode\u003einstallScope\u003c/code\u003e\nvalue to \u003ccode\u003enamespace\u003c/code\u003e. This will cause the Helm Chart to install a\nnamespace-scoped \u003ccode\u003eRoleBinding\u003c/code\u003e with the necessary permissions the controller\nneeds to create, update, read, list and watch the ACK custom resources managed\nby the controller.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="cluster-mode"\u003eCluster Mode\u003c/h3\u003e\n\u003cp\u003eWhen a service controller is started in Cluster Mode, the \u003ccode\u003e--watch-namespace\u003c/code\u003e\nflag is not supplied and the controller will watch for ACK custom resources\n(CRs) across \u003cem\u003eall\u003c/em\u003e Kubernetes \u003ccode\u003eNamespaces\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eControllers started in Cluster Mode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the controller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eClusterRole\u003c/code\u003e\nwith permissions to create, update/patch, delete, read, list and watch ACK\ncustom resources matching the associated AWS service in \u003cem\u003eall\u003c/em\u003e Kubernetes\n\u003ccode\u003eNamespaces\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eTo support cross-account resource management, controllers started in Cluster\nMode require that the Kubernetes \u003ccode\u003eService Account\u003c/code\u003e associated with the\ncontroller\u0026rsquo;s \u003ccode\u003eDeployment\u003c/code\u003e have a \u003ccode\u003eClusterRole\u003c/code\u003e with permissions to read, list\nand watch \u003cem\u003eall\u003c/em\u003e \u003ccode\u003eNamespace\u003c/code\u003e objects.\u003c/p\u003e\n\u003cp\u003eAdditionally, the \u003ccode\u003eClusterRole\u003c/code\u003e will need permissions to read \u003ccode\u003eConfigMap\u003c/code\u003e\nresources in a specific Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e identified by the environment\nvariable \u003ccode\u003eACK_SYSTEM_NAMESPACE\u003c/code\u003e, defaulting to \u003ccode\u003eack-system\u003c/code\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Cross-account resource management requires Cluster Mode\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you plan to use an ACK service controller to manage resources across many\nAWS accounts (cross-account resource management, or CARM), you \u003cem\u003emust\u003c/em\u003e start the\ncontroller in Cluster Mode.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="permission-to-read-secret-objects"\u003ePermission to read \u003ccode\u003eSecret\u003c/code\u003e objects\u003c/h3\u003e\n\u003cp\u003eSome ACK service controllers will replace plain-text values for some resource\nfields with the value of Kubernetes \u003ccode\u003eSecret\u003c/code\u003e keys.\u003c/p\u003e\n\u003cp\u003eFor controllers started in Namespace Mode, the \u003ccode\u003eRole\u003c/code\u003e must have permissions to\nread \u003ccode\u003eSecret\u003c/code\u003e objects in the Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e identified by the\n\u003ccode\u003e--watch-namespace\u003c/code\u003e flag.\u003c/p\u003e\n\u003cp\u003eFor controllers started in Cluster Mode, the \u003ccode\u003eClusterRole\u003c/code\u003e must have\npermissions to read \u003ccode\u003eSecret\u003c/code\u003e resources in \u003cem\u003eany Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e within\nwhich ACK custom resources may be launched\u003c/em\u003e.\u003c/p\u003e\n\u003cp\u003eIn order to support the \u003ccode\u003eFieldExport\u003c/code\u003e custom resource, all controllers will\ninstall with permissions to read and patch \u003ccode\u003eConfigMap\u003c/code\u003e and \u003ccode\u003eSecret\u003c/code\u003e resources in\nany namespace. Read the \u003ca href="../field-export/"\u003edocumentation on \u003ccode\u003eFieldExport\u003c/code\u003e\u003c/a\u003e for more\ninformation about the RBAC scope.\u003c/p\u003e\n\u003ch3 id="roles-for-reading-and-writing-ack-custom-resources"\u003eRoles for reading and writing ACK custom resources\u003c/h3\u003e\n\u003cp\u003eAs part of installation, Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources are automatically created. These roles contain permissions to modify the Kubernetes custom resources (CRs) that the ACK service controller is responsible for.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n ACK resources are namespace-scoped\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n All Kubernetes CRs managed by an ACK service controller are namespace-scoped resources. There are no cluster-scoped ACK-managed CRs.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eBy default, the following Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources are created when installing an ACK service controller:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003eack-$SERVICE-writer\u003c/code\u003e: a \u003ccode\u003eRole\u003c/code\u003e used for reading and mutating namespace-scoped CRs that the ACK service controller manages.\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eack-$SERVICE-reader\u003c/code\u003e: a \u003ccode\u003eRole\u003c/code\u003e used for reading namespaced-scoped CRs that the ACK service controller manages.\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor example, installing the ACK service controller for AWS S3 creates the \u003ccode\u003eack-s3-writer\u003c/code\u003e and \u003ccode\u003eack-s3-reader\u003c/code\u003e roles, both with a \u003ccode\u003eGroupKind\u003c/code\u003e of \u003ccode\u003es3.services.k8s.aws/Bucket\u003c/code\u003e within a specific Kubernetes \u003ccode\u003eNamespace\u003c/code\u003e.\u003c/p\u003e\n\u003ch3 id="bind-a-kubernetes-user-to-a-kubernetes-role"\u003eBind a Kubernetes user to a Kubernetes role\u003c/h3\u003e\n\u003cp\u003eOnce the Kubernetes \u003ccode\u003eRole\u003c/code\u003e resources have been created, you can assign a specific Kubernetes \u003ccode\u003eUser\u003c/code\u003e to a particular \u003ccode\u003eRole\u003c/code\u003e with the \u003ccode\u003ekubectl create rolebinding\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl create rolebinding alice-ack-s3-writer --role ack-s3-writer --namespace testing --user alice\nkubectl create rolebinding alice-ack-sns-reader --role ack-sns-reader --namespace production --user alice\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can check the permissions of a particular Kubernetes \u003ccode\u003eUser\u003c/code\u003e with the \u003ccode\u003ekubectl auth can-i\u003c/code\u003e command.\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003ekubectl auth can-i create buckets --namespace default\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="aws-iam-permissions-for-ack-controller"\u003eAWS IAM permissions for ACK controller\u003c/h2\u003e\n\u003cp\u003eThe IAM role needs the correct \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html"\u003eIAM policies\u003c/a\u003e for a given ACK service controller. For example, the ACK service controller for AWS S3 needs read and write permission for S3 Buckets. It is recommended that the IAM policy gives only enough access to properly manage the resources needed for a specific AWS service.\u003c/p\u003e\n\u003cp\u003eTo use the recommended IAM policy for a given ACK service controller, refer to the \u003ccode\u003erecommended-policy-arn\u003c/code\u003e file in the \u003ccode\u003econfig/iam/\u003c/code\u003e folder within that service\u0026rsquo;s public repository. This document contains the AWS Resource Name (ARN) of the recommended managed policy for a specific service. For example, the \u003ca href="https://github.com/aws-controllers-k8s/s3-controller/tree/main/config/iam"\u003erecommended IAM policy ARN for AWS S3\u003c/a\u003e is: \u003ccode\u003earn:aws:iam::aws:policy/AmazonS3FullAccess\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eSome services may need an additional inline policy. For example, the service controller may require \u003ccode\u003eiam:PassRole\u003c/code\u003e permission in order to pass an execution role that will be assumed by the AWS service. If applicable, resources for additional recommended policies will be located in the \u003ccode\u003erecommended-inline-policy\u003c/code\u003e file within the \u003ccode\u003econfig/iam\u003c/code\u003e folder of a given ACK service controller\u0026rsquo;s public repository. This inline policy is applied along with the managed policies when creating the role.\u003c/p\u003e\n\u003cp\u003eIf you have not yet created an IAM role, see the user documentation on how to \u003ca href="../irsa/#create-an-iam-role-for-your-ack-service-controller"\u003ecreate an IAM role for your ACK service controller\u003c/a\u003e.\u003c/p\u003e\n'}).add({id:36,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/testing/",title:"Testing",description:"How to test an ACK service controller",content:'\u003cp\u003eIn the following, we will take you through the steps to run end-to-end (e2e)\ntests for the ACK service controller for S3. You may use these steps to run e2e\ntests for other ACK service controllers.\u003c/p\u003e\n\u003cp\u003eIf you run into any problems when testing a service controller, please\n\u003ca href="https://github.com/aws-controllers-k8s/community/issues/new/choose"\u003eraise an issue\u003c/a\u003e\nwith the details so we can reproduce your issue.\u003c/p\u003e\n\u003ch2 id="prerequisites"\u003ePrerequisites\u003c/h2\u003e\n\u003cp\u003eFor local development and testing we use \u0026ldquo;Kubernetes in Docker\u0026rdquo; (\u003ccode\u003ekind\u003c/code\u003e),\nwhich in turn requires Docker.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Footprint\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When you run the \u003ccode\u003escripts/start.sh\u003c/code\u003e script the first time,\nthe step that builds the container image for the target ACK service controller\ncan take up to 10 or more minutes. This is because the container image contains\na lot of dependencies. Once you successfully built the target image this base\nimage layer is cached locally, and the build takes a much shorter amount of\ntime. We are aware of this and aim to reduce both in the fullness of time.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eIn summary, in order to test ACK you will need to have the following tools\ninstalled and configured:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="https://golang.org/doc/install"\u003eGolang 1.17+\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003emake\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.docker.com/get-docker/"\u003eDocker\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kind.sigs.k8s.io/docs/user/quick-start/"\u003ekind\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kubernetes.io/docs/tasks/tools/"\u003ekubectl\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://helm.sh/docs/intro/install/"\u003eHelm\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://kubectl.docs.kubernetes.io/installation/kustomize/binaries/"\u003ekustomize\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://github.com/stedolan/jq/wiki/Installation"\u003ejq\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://mikefarah.gitbook.io/yq/#install"\u003eyq\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eTo build and test an ACK controller with \u003ccode\u003ekind\u003c/code\u003e, \u003cstrong\u003eexecute the commands as\ndescribed in the following from the root directory of the\n\u003ccode\u003egithub.com/aws-controllers-k8s/test-infra\u003c/code\u003e repository\u003c/strong\u003e.\u003c/p\u003e\n\u003cp\u003eYou should have forked this repository and \u003ccode\u003egit clone\u003c/code\u003e\u0026rsquo;d it locally when\n\u003ca href="../setup/"\u003esetting up your development environment\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Recommended RAM\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n Given that our test setup creates the container images and then launches\na test cluster, we recommend that you have at least 4GB of RAM available\nfor the tests.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eWith the prerequisites out of the way, let\u0026rsquo;s move on to running e2e tests for a\nservice controller.\u003c/p\u003e\n\u003ch2 id="run-tests"\u003eRun tests\u003c/h2\u003e\n\u003cp\u003eTime to run the end-to-end test.\u003c/p\u003e\n\u003ch3 id="test-configuration-file-setup"\u003eTest configuration file setup\u003c/h3\u003e\n\u003cp\u003eThe e2e tests should be configured through a \u003ccode\u003etest_config.yaml\u003c/code\u003e file that lives\nin the root of your \u003ccode\u003etest-infra\u003c/code\u003e directory. We have provided a\n\u003ccode\u003etest_config.example.yaml\u003c/code\u003e file which contains the description for each\nconfiguration option and its default value. Copy this configuration file and\ncustomize it for your own needs:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecp test_config.example.yaml test_config.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eTake some time to look over each of the available options in the configuration\nfile and make changes to suit your preferences.\u003c/p\u003e\n\u003ch4 id="iam-setup"\u003eIAM Setup\u003c/h4\u003e\n\u003cp\u003eIn order for the ACK service controller to manage the S3 bucket, it needs an\nidentity. In other words, it needs an IAM role that represents the ACK service\ncontroller towards the S3 service.\u003c/p\u003e\n\u003cp\u003eFirst, define the name of the IAM role that will have the permission to manage\nS3 buckets on your behalf:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_TEST_IAM_ROLE=Admin-k8s\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we need to verify the IAM principal (likely an IAM user) that is going to\nassume the IAM role \u003ccode\u003eACK_TEST_IAM_ROLE\u003c/code\u003e. So to get its ARN, execute:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport ACK_TEST_PRINCIPAL_ARN=$(aws sts get-caller-identity --query \'Arn\' --output text)\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can verify if that worked using \u003ccode\u003eecho $ACK_TEST_PRINCIPAL_ARN\u003c/code\u003e and that should\nprint something along the lines of \u003ccode\u003earn:aws:iam::1234567890121:user/ausername\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eNext up, create the IAM role, adding the necessary trust relationship to the\nrole, using the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecat \u0026gt; trust-policy.json \u0026lt;\u0026lt; EOF\n{\n \u0026quot;Version\u0026quot;: \u0026quot;2012-10-17\u0026quot;,\n \u0026quot;Statement\u0026quot;: {\n \u0026quot;Effect\u0026quot;: \u0026quot;Allow\u0026quot;,\n \u0026quot;Principal\u0026quot;: {\n \u0026quot;AWS\u0026quot;: \u0026quot;$ACK_TEST_PRINCIPAL_ARN\u0026quot;\n },\n \u0026quot;Action\u0026quot;: \u0026quot;sts:AssumeRole\u0026quot;\n }\n}\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUsing above trust policy, we can now create the IAM role:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-role \\\n --role-name $ACK_TEST_IAM_ROLE \\\n --assume-role-policy-document file://trust-policy.json\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow we\u0026rsquo;re in the position to give the IAM role \u003ccode\u003eACK_TEST_IAM_ROLE\u003c/code\u003e the\npermission to handle S3 buckets for us, using:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam attach-role-policy \\\n --role-name $ACK_TEST_IAM_ROLE \\\n --policy-arn \u0026quot;arn:aws:iam::aws:policy/AmazonS3FullAccess\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n IAM policies for other services\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eIf you are running tests on a service other than S3, you will need to find the\nrecommended policy ARN for the given service. The ARN is stored in\n[\u003ccode\u003econfig/iam/recommended-policy-arn\u003c/code\u003e][recc-arn] in each controller repository.\u003c/p\u003e\n\u003cp\u003eSome services don\u0026rsquo;t have a single policy ARN to represent all of the permissions\nrequired to run their controller. Instead you can find an [inline\npolicy][inline-policy] in the\n[\u003ccode\u003econfig/iam/recommended-inline-policy\u003c/code\u003e][recc-inline] in each applicable\ncontroller repository. This can be applied to the role using [\u003ccode\u003eaws iam put-role-policy\u003c/code\u003e][put-role-policy].\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Access delegation in IAM\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you\u0026rsquo;re not that familiar with IAM access delegation, we recommend you\nto peruse the [IAM documentation][iam-docs]\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eNext, in order for our test to generate \u003ca href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html"\u003etemporary credentials\u003c/a\u003e\nwe need to tell it to use the IAM role we created in the previous step.\nTo generate the IAM role ARN and update your configuration file, do:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ACCOUNT_ID=$(aws sts get-caller-identity --query \'Account\' --output text) \u0026amp;\u0026amp; \\\nASSUMED_ROLE_ARN=arn:aws:iam::${AWS_ACCOUNT_ID}:role/${ACK_TEST_IAM_ROLE} \\\nyq -i \'.aws.assumed_role_arn = env(ASSUMED_ROLE_ARN)\' test_config.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n The tests uses the \u003ccode\u003egenerate_temp_creds\u003c/code\u003e function from the\n\u003ccode\u003escripts/lib/aws.sh\u003c/code\u003e script, executing effectively\n\u003ccode\u003eaws sts assume-role --role-session-arn $ASSUMED_ROLE_ARN --role-session-name $TEMP_ROLE \u003c/code\u003e\nwhich fetches temporarily \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e, \u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e,\nand an \u003ccode\u003eAWS_SESSION_TOKEN\u003c/code\u003e used in turn to authentication the ACK\ncontroller. The duration of the session token is 900 seconds (15 minutes).\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003ePhew that was a lot to set up, but good news: you\u0026rsquo;re almost there.\u003c/p\u003e\n\u003ch3 id="run-end-to-end-test"\u003eRun end-to-end test\u003c/h3\u003e\n\u003cp\u003eBefore you proceed, make sure that you\u0026rsquo;ve done the configuration file setup in\nthe previous step.\u003c/p\u003e\n\u003cp\u003eNow we\u0026rsquo;re finally in the position to execute the end-to-end test:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003emake kind-test SERVICE=$SERVICE\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThis provisions a Kubernetes cluster using \u003ccode\u003ekind\u003c/code\u003e, builds a container image with\nthe ACK service controller, and loads the container image into the \u003ccode\u003ekind\u003c/code\u003e\ncluster.\u003c/p\u003e\n\u003cp\u003eIt then installs the ACK service controller and related Kubernetes manifests\ninto the \u003ccode\u003ekind\u003c/code\u003e cluster using \u003ccode\u003ekustomize build | kubectl apply -f -\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003eFirst, it will attempt to install the Helm chart for the controller to ensure\nthe default values are safe and that the controller stands up properly.\u003c/p\u003e\n\u003cp\u003eThen, the above script builds a testing container, containing a Python\nenvironment and the testing libraries we use, and runs the e2e tests for the\ncontroller within that environment. These tests create, update and delete each\nof the ACK resources and ensure their properties are properly mirrored in the\nAWS service. The output of the test script should look like the following\n(edited down to the relevant parts):\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003e2022-07-15T19:52:55+0000 [INFO] Creating KIND cluster ...\n2022-07-15T19:52:55+0000 [INFO] Creating cluster with name \u0026quot;ack-test-e9e83a17\u0026quot;\n2022-07-15T19:52:55+0000 [INFO] Using configuration \u0026quot;kind-two-node-cluster.yaml\u0026quot;\nCreating cluster \u0026quot;ack-test-e9e83a17\u0026quot; ...\n ✓ Ensuring node image (kindest/node:v1.22.9) 🖼\n ✓ Preparing nodes 📦 📦\n ✓ Writing configuration 📜\n ✓ Starting control-plane 🕹️\n ✓ Installing CNI 🔌\n ✓ Installing StorageClass 💾\n ✓ Joining worker nodes 🚜\nSet kubectl context to \u0026quot;kind-ack-test-e9e83a17\u0026quot;\nYou can now use your cluster with:\n\nkubectl cluster-info --context kind-ack-test-e9e83a17 --kubeconfig /local/home/nithomso/go/src/github.com/aws-controllers-k8s/test-infra/scripts/../build/clusters/ack-test-e9e83a17/kubeconfig\n\nNot sure what to do next? 😅 Check out https://kind.sigs.k8s.io/docs/user/quick-start/\n2022-07-15T19:53:42+0000 [INFO] Exporting KUBECONFIG=/local/home/nithomso/go/src/github.com/aws-controllers-k8s/test-infra/scripts/../build/clusters/ack-test-e9e83a17/kubeconfig\n2022-07-15T19:53:42+0000 [INFO] Building controller image ...\nWARNING! Your password will be stored unencrypted in /home/nithomso/.docker/config.json.\nConfigure a credential helper to remove this warning. See\nhttps://docs.docker.com/engine/reference/commandline/login/#credentials-store\n\n[+] Building 352.7s (21/21) FINISHED\n =\u0026gt; [internal] load build definition from Dockerfile 0.0s\n =\u0026gt; =\u0026gt; transferring dockerfile: 39B 0.0s\n =\u0026gt; [internal] load .dockerignore 0.0s\n =\u0026gt; =\u0026gt; transferring context: 2B 0.0s\n =\u0026gt; [internal] load metadata for public.ecr.aws/eks-distro-build-tooling/eks-distro-minim 0.2s\n =\u0026gt; [internal] load metadata for public.ecr.aws/bitnami/golang:1.17 0.5s\n =\u0026gt; [auth] aws:: eks-distro-build-tooling/eks-distro-minimal-base-nonroot:pull token for 0.0s\n =\u0026gt; [auth] aws:: bitnami/golang:pull token for public.ecr.aws 0.0s\n =\u0026gt; [builder 1/11] FROM public.ecr.aws/bitnami/golang:1.17@sha256:386b0edb486b872c5db270 9.9s\n =\u0026gt; =\u0026gt; resolve public.ecr.aws/bitnami/golang:1.17@sha256:386b0edb486b872c5db2702c997ac364 0.0s\n =\u0026gt; =\u0026gt; sha256:386b0edb486b872c5db2702c997ac364749d5b52908ba2f8db33e67e32c 1.58kB / 1.58kB 0.0s\n =\u0026gt; =\u0026gt; sha256:6474ea435b8fd7c66546676ee6bb9fafdede6679aa57119d3b3e91c23c9 4.25kB / 4.25kB 0.0s\n =\u0026gt; =\u0026gt; sha256:e4d5dd6e67b14bf5bfc57a4ed6126d2ff9618ae17a809ba0eed98b68d 30.87MB / 30.87MB 0.5s\n =\u0026gt; =\u0026gt; sha256:163e77b4424a8a2f2433544cd177d3ab5b67cd42ff2a6332788f2569a53e076 768B / 768B 0.2s\n =\u0026gt; =\u0026gt; sha256:1f31511aab3c72a7f8227e41e7c0b2d71ba2b0bef7c18c9ae8343f9 125.13MB / 125.13MB 4.0s\n =\u0026gt; =\u0026gt; sha256:c9e9361513e51d32efbc5726aa75f2bf6a0ee5d59d5ef002f127bd1 135.04MB / 135.04MB 5.3s\n =\u0026gt; =\u0026gt; extracting sha256:e4d5dd6e67b14bf5bfc57a4ed6126d2ff9618ae17a809ba0eed98b68d62c200d 0.7s\n =\u0026gt; =\u0026gt; sha256:f6e1dc6697990041781953a87be7a91a0b0a30f436b93fc277f2a160fd41f87 258B / 258B 0.6s\n =\u0026gt; =\u0026gt; sha256:6ec6c2b2145be26a5e68b86aadf441144a44f1bba0e70b3cab1988d286814d5 124B / 124B 0.7s\n =\u0026gt; =\u0026gt; extracting sha256:163e77b4424a8a2f2433544cd177d3ab5b67cd42ff2a6332788f2569a53e0769 0.0s\n =\u0026gt; =\u0026gt; extracting sha256:1f31511aab3c72a7f8227e41e7c0b2d71ba2b0bef7c18c9ae8343f9739f78dfa 2.4s\n =\u0026gt; =\u0026gt; extracting sha256:c9e9361513e51d32efbc5726aa75f2bf6a0ee5d59d5ef002f127bd1b503582b3 2.9s\n =\u0026gt; =\u0026gt; extracting sha256:f6e1dc6697990041781953a87be7a91a0b0a30f436b93fc277f2a160fd41f87c 0.0s\n =\u0026gt; =\u0026gt; extracting sha256:6ec6c2b2145be26a5e68b86aadf441144a44f1bba0e70b3cab1988d286814d51 0.0s\n =\u0026gt; CACHED [stage-1 1/3] FROM public.ecr.aws/eks-distro-build-tooling/eks-distro-minimal- 0.0s\n =\u0026gt; [internal] load build context 0.0s\n =\u0026gt; =\u0026gt; transferring context: 567.03kB 0.0s\n =\u0026gt; [builder 2/11] WORKDIR /github.com/aws-controllers-k8s/s3-controller 0.8s\n =\u0026gt; [builder 3/11] COPY s3-controller/LICENSE /github.com/aws-controllers-k8s/s3-control 0.0s\n =\u0026gt; [builder 4/11] COPY s3-controller/ATTRIBUTION.md /github.com/aws-controllers-k8s/s3- 0.0s\n =\u0026gt; [builder 5/11] COPY s3-controller/go.mod /github.com/aws-controllers-k8s/s3-controll 0.0s\n =\u0026gt; [builder 6/11] COPY s3-controller/go.sum /github.com/aws-controllers-k8s/s3-controll 0.0s\n =\u0026gt; [builder 7/11] RUN go mod download 319.2s\n =\u0026gt; [builder 8/11] COPY s3-controller/apis /github.com/aws-controllers-k8s/s3-controller 0.0s\n =\u0026gt; [builder 9/11] COPY s3-controller/cmd /github.com/aws-controllers-k8s/s3-controller/ 0.0s\n =\u0026gt; [builder 10/11] COPY s3-controller/pkg /github.com/aws-controllers-k8s/s3-controller/ 0.0s\n =\u0026gt; [builder 11/11] RUN GIT_VERSION=v0.1.0-dirty \u0026amp;\u0026amp; GIT_COMMIT=46e9abeeae0e5838fdb65 21.4s\n =\u0026gt; [stage-1 2/3] COPY --from=builder /github.com/aws-controllers-k8s/s3-controller/bin/c 0.1s\n =\u0026gt; exporting to image 0.3s\n =\u0026gt; =\u0026gt; exporting layers 0.2s\n =\u0026gt; =\u0026gt; writing image sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064c 0.0s\n =\u0026gt; =\u0026gt; naming to docker.io/library/aws-controllers-k8s:s3-v0.1.0-dirty 0.0s\n2022-07-15T19:59:37+0000 [INFO] Loading image into cluster ...\nImage: \u0026quot;aws-controllers-k8s:s3-v0.1.0-dirty\u0026quot; with ID \u0026quot;sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064cfa8\u0026quot; not yet present on node \u0026quot;ack-test-e9e83a17-worker\u0026quot;, loading...\nImage: \u0026quot;aws-controllers-k8s:s3-v0.1.0-dirty\u0026quot; with ID \u0026quot;sha256:57d227f5a6830f09da5d2e16ca5d4dfc48fd0473eb4f9a604de1de241064cfa8\u0026quot; not yet present on node \u0026quot;ack-test-e9e83a17-control-plane\u0026quot;, loading...\n2022-07-15T19:59:40+0000 [INFO] Installing controller deployment ...\nnamespace/ack-system created\nWarning: resource namespaces/ack-system is missing the kubectl.kubernetes.io/last-applied-configuration annotation which is required by kubectl apply. kubectl apply should only be used on resources created declaratively by either kubectl create --save-config or kubectl apply. The missing annotation will be patched automatically.\n2022-07-15T19:59:47+0000 [INFO] Sleeping for 50 mins before rotating temporary aws credentials\n2022-07-15T19:59:47+0000 [INFO] Building e2e test container for s3 ...\n2022-07-15T20:00:11+0000 [INFO] Running e2e test container for s3 ...\n2022-07-15T20:00:11+00:00 [INFO] Running test bootstrap ...\nINFO:root:🛠️ Bootstrapping resources ...\nINFO:root:Attempting bootstrap Bucket\nINFO:root:Successfully bootstrapped Bucket\nINFO:root:Attempting bootstrap Role\nINFO:root:Attempting bootstrap UserPolicies\nINFO:root:Successfully bootstrapped UserPolicies\nINFO:root:Successfully bootstrapped Role\nINFO:root:Attempting bootstrap Topic\nINFO:root:Successfully bootstrapped Topic\nINFO:root:Wrote bootstrap to /s3-controller/tests/e2e/bootstrap.pkl\n2022-07-15T20:00:18+00:00 [INFO] Running tests ...\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch4 id="repeat-for-other-services"\u003eRepeat for other services\u003c/h4\u003e\n\u003cp\u003eWe have end-to-end tests for all services listed in the \u003ccode\u003eDEVELOPER-PREVIEW\u003c/code\u003e,\n\u003ccode\u003eBETA\u003c/code\u003e and \u003ccode\u003eGA\u003c/code\u003e release statuses in our \u003ca href="../../community/services"\u003eservice listing\u003c/a\u003e\ndocument. Simply replace your \u003ccode\u003eSERVICE\u003c/code\u003e environment variable with the name of a\nsupported service and re-run the IAM and test steps outlined above.\u003c/p\u003e\n\u003ch3 id="unit-testing"\u003eUnit testing\u003c/h3\u003e\n\u003cp\u003eWe use \u003ca href="https://github.com/vektra/mockery"\u003emockery\u003c/a\u003e for unit testing.\nYou can install it by following the guideline on mockery\u0026rsquo;s GitHub or simply\nby running our handy script at \u003ccode\u003e./scripts/install-mockery.sh\u003c/code\u003e for general\nLinux environments.\u003c/p\u003e\n\u003ch2 id="clean-up"\u003eClean up\u003c/h2\u003e\n\u003cp\u003eTo clean up a \u003ccode\u003ekind\u003c/code\u003e cluster, including the container images and configuration\nfiles created by the script specifically for said test cluster, execute:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekind delete cluster --name $CLUSTER_NAME\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eIf you want to delete all \u003ccode\u003ekind\u003c/code\u003e cluster running on your machine, use:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekind delete clusters --all\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eWith this the testing is completed. Thanks for your time and we appreciate your\nfeedback.\u003c/p\u003e\n'}).add({id:37,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/authentication/",title:"Authentication and Credentials",description:"Understanding how AWS credentials are determined for an ACK controller",content:'\u003cp\u003eWhen an ACK service controller communicates with an AWS service API, the\ncontroller uses a set of \u003ca href="https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html"\u003e\u003cem\u003eAWS Credentials\u003c/em\u003e\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eThis document explains the process by which these credentials are determined by\nthe ACK service controller and how ACK users can configure the ACK service\ncontroller to use a particular set of credentials.\u003c/p\u003e\n\u003ch2 id="background"\u003eBackground\u003c/h2\u003e\n\u003cp\u003eEach ACK service controller uses the \u003ca href="https://github.com/aws/aws-sdk-go/"\u003e\u003ccode\u003eaws-sdk-go\u003c/code\u003e\u003c/a\u003e library to call\nthe AWS service APIs.\u003c/p\u003e\n\u003cp\u003eWhen initiating communication with an AWS service API, the ACK controller\n\u003ca href="https://github.com/aws-controllers-k8s/runtime/blob/7abfd4e9bf9c835b76e06603617cae50c39af42e/pkg/runtime/session.go#L58"\u003ecreates\u003c/a\u003e a new \u003ccode\u003eaws-sdk-go\u003c/code\u003e \u003ccode\u003eSession\u003c/code\u003e object. This \u003ccode\u003eSession\u003c/code\u003e\nobject is automatically configured during construction by code in the\n\u003ccode\u003eaws-sdk-go\u003c/code\u003e library that \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/session/credentials.go#L19"\u003elooks for credential information\u003c/a\u003e in the\nfollowing places, \u003cem\u003ein this specific order\u003c/em\u003e:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_PROFILE\u003c/code\u003e environment variable is set, \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/session/credentials.go#L85"\u003efind\u003c/a\u003e that\nspecified profile in the configured \u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003ecredentials file\u003c/a\u003e and use\nthat profile\u0026rsquo;s credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e and \u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e environment variables\nare both set, these \u003ca href="https://github.com/aws/aws-sdk-go/blob/2c3daca245ce07c2e12beb7ccbf6ce4cf7a97c5a/aws/credentials/env_provider.go#L41-L69"\u003evalues are used\u003c/a\u003e by \u003ccode\u003eaws-sdk-go\u003c/code\u003e to set the\nAWS credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf the \u003ccode\u003eAWS_WEB_IDENTITY_TOKEN_FILE\u003c/code\u003e environment variable is set,\n\u003ccode\u003eaws-sdk-go\u003c/code\u003e will load the credentials from the JSON web token (JWT) present\nin the file pointed to by this environment variable. Note that this\nenvironment variable is set to the value\n\u003ccode\u003e/var/run/secrets/eks.amazonaws.com/serviceaccount/token\u003c/code\u003e by the IAM Roles\nfor Service Accounts (IRSA) pod identity webhook and the contents of this\nfile are automatically rotated by the webhook with temporary credentials.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf there is a credentials file present at the location specified in the\n\u003ccode\u003eAWS_SHARED_CREDENTIALS_FILE\u003c/code\u003e environment variable (or\n\u003ccode\u003e$HOME/.aws/credentials\u003c/code\u003e if empty), \u003ccode\u003eaws-sdk-go\u003c/code\u003e will load the \u0026ldquo;default\u0026rdquo;\nprofile present in the credentials file.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id="configuring-credentials"\u003eConfiguring credentials\u003c/h2\u003e\n\u003cp\u003eThere are multiple ways in which you can configure an ACK service controller to\nuse a particular set of AWS credentials:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eWeb identity token file (recommended)\u003c/li\u003e\n\u003cli\u003eShared credentials file\u003c/li\u003e\n\u003cli\u003eAccess key and secret access key environment variables (not recommended)\u003c/li\u003e\n\u003c/ul\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Understand the AWS credentials file format\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n It is important to understand the \u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003eAWS credentials file format\u003c/a\u003e,\nespecially if you choose not to use the web identity token file method of\ncredential configuration.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="use-a-web-identity-token-file-recommended"\u003eUse a web identity token file (recommended)\u003c/h3\u003e\n\u003cp\u003eOur recommended approach for configuring the AWS credentials that an ACK\nservice controller will use to communicate with AWS services is to use the IAM\nRoles for Service Accounts (IRSA) functionality provided by the IAM Pod\nIdentity Webhook and OIDC connector.\u003c/p\u003e\n\u003cp\u003eUsing IRSA means that you only need to configure the IAM Role that is\nassociated with the Kubernetes Service Account of the ACK service controller\u0026rsquo;s\nKubernetes Pod. The Pod Identity Webhook will be responsible for automatically\ninjecting \u003cem\u003eand periodically rotating\u003c/em\u003e the web identity token file into your ACK\nservice controller\u0026rsquo;s Pod.\u003c/p\u003e\n\u003cp\u003eLearn \u003ca href="../irsa/"\u003ehow to configure IRSA\u003c/a\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Understand the AWS credentials file format\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n IRSA is enabled and installed on EKS clusters by default, however must be\nmanually configured if you are using a non-EKS cluster. See the IRSA\n\u003ca href="https://github.com/aws/amazon-eks-pod-identity-webhook/blob/master/SELF_HOSTED_SETUP.md"\u003eself-hosted documentation\u003c/a\u003e for information about installing the\npod identity webhook in non-EKS clusters.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="use-a-shared-credentials-file"\u003eUse a shared credentials file\u003c/h3\u003e\n\u003cp\u003eIf you are not using IAM Roles for Service Accounts (IRSA) or are running in an\nenvironment where IRSA isn\u0026rsquo;t feasible (such as running KinD clusters within\nKubernetes Pods using Docker-in-Docker), you can choose to instruct the ACK\nservice controller to use AWS credentials found in a\n\u003ca href="https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html"\u003eshared credentials file\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eWhen using a shared credentials file, the ACK service controller will need read\naccess to a known credentials file location.\u003c/p\u003e\n\u003cp\u003eIf you do \u003cem\u003enot\u003c/em\u003e set the \u003ccode\u003eAWS_SHARED_CREDENTIALS_FILE\u003c/code\u003e environment variable, the\ncontroller will look for a readable file at \u003ccode\u003e$HOME/.aws/credentials\u003c/code\u003e.\u003c/p\u003e\n\u003cp\u003ePractically, this means that the \u003ccode\u003eDeployment\u003c/code\u003e spec you use to deploy the ACK\nservice controller should have a \u003ca href="https://kubernetes.io/docs/concepts/storage/volumes/"\u003evolume mount\u003c/a\u003e that mounts a\nreadonly file containing the credentials file.\u003c/p\u003e\n\u003cp\u003eLet\u0026rsquo;s assume you have stored your local AWS credentials file content in a\nKubernetes \u003ccode\u003eSecret\u003c/code\u003e named \u003ccode\u003eaws-creds\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eCREDS_CONTENT=$(cat ~/.aws/credentials)\ncat \u0026lt;\u0026lt;EOF | kubectl apply -f -\napiVersion: v1\nkind: Secret\nmetadata:\n name: aws-creds\ntype: Opaque\nstringData:\n credentials-file: |\n $CREDS_CONTENT\nEOF\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou would want to mount a readonly volume into the \u003ccode\u003eDeployment\u003c/code\u003e for your ACK\nservice controller. Here\u0026rsquo;s how you might do this for a sample ACK controller:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: ack-s3-controller\nspec:\n replicas: 1\n template:\n spec:\n containers:\n - command:\n - ./bin/controller\n image: controller:latest\n name: controller\n ports:\n - name: http\n containerPort: 8080\n resources:\n limits:\n cpu: 100m\n memory: 300Mi\n requests:\n cpu: 100m\n memory: 200Mi\n volumeMounts:\n - name: aws-creds\n mountPath: \u0026quot;/root/.aws/credentials\u0026quot;\n readOnly: true\n volumes:\n - name: aws-creds\n secret:\n secretName: aws-creds\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can instruct the service controller to use a specific profile within the\nshared credentials file by setting the \u003ccode\u003eAWS_PROFILE\u003c/code\u003e environment variable for\nthe \u003ccode\u003ePod\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003e env:\n - name: AWS_PROFILE\n value: my-profile\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="use-access-key-and-secret-access-key-environment-variables-not-recommended"\u003eUse access key and secret access key environment variables (not recommended)\u003c/h3\u003e\n\u003cp\u003eFinally, you can choose to manually set the \u003ccode\u003eAWS_ACCESS_KEY_ID\u003c/code\u003e,\n\u003ccode\u003eAWS_SECRET_ACCESS_KEY\u003c/code\u003e and optionally the \u003ccode\u003eAWS_SESSION_TOKEN\u003c/code\u003e environment\nvariables on the ACK service controller\u0026rsquo;s \u003ccode\u003ePod\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl -n ack-system set env deployment/ack-s3-controller \\\n AWS_ACCESS_KEY_ID=\u0026quot;$AWS_ACCESS_KEY_ID\u0026quot; \\\n AWS_SECRET_ACCESS_KEY=\u0026quot;$AWS_SECRET_ACCESS_KEY\u0026quot; \\\n AWS_SESSION_TOKEN=\u0026quot;$AWS_SESSION_TOKEN\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:38,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/field-export/",title:"Copy a resource field into a ConfigMap or Secret",description:"Using the FieldExport custom resource",content:'\u003cp\u003eACK controllers are intended to manage your AWS infrastructure using Kubernetes\ncustom resources. Their responsibilities end after managing the lifecycle of\nyour AWS resource and do not extend into binding to applications running in the\nKubernetes data plane. The ACK \u003ccode\u003eFieldExport\u003c/code\u003e custom resource was designed to\nbridge the gap between managing the control plane of your ACK resources and\nusing the properties of those resources in your application.\u003c/p\u003e\n\u003cp\u003eThe \u003ccode\u003eFieldExport\u003c/code\u003e resource configures an ACK controller to export any spec or\nstatus field from an ACK resource into a Kubernetes \u003ccode\u003eConfigMap\u003c/code\u003e or \u003ccode\u003eSecret\u003c/code\u003e.\nThese fields are automatically updated when any field value changes. You are\nthen able to mount the \u003ccode\u003eConfigMap\u003c/code\u003e or \u003ccode\u003eSecret\u003c/code\u003e onto your Kubernetes Pods as\nenvironment variables that can ingest those values.\u003c/p\u003e\n\u003cp\u003e\u003ccode\u003eFieldExport\u003c/code\u003e is included by default in every ACK controller installation and\ncan be used to reference any field within the \u003ccode\u003eSpec\u003c/code\u003e or \u003ccode\u003eStatus\u003c/code\u003e of any ACK\nresource.\u003c/p\u003e\n\u003ch2 id="using-a-fieldexport"\u003eUsing a FieldExport\u003c/h2\u003e\n\u003cp\u003eThe \u003ccode\u003eSpec\u003c/code\u003e and \u003ccode\u003eStatus\u003c/code\u003e fields of the \u003ccode\u003eFieldExport\u003c/code\u003e custom resource definition\nare available in the \u003ca href="../../../reference/common/v1alpha1/fieldexport/"\u003eAPI reference\u003c/a\u003e. For this example, we will\nbe creating an \u003ca href="../../../reference/s3/v1alpha1/fieldexport/bucket/#spec"\u003eS3 Bucket\u003c/a\u003e and exporting the \u003ccode\u003eStatus.Location\u003c/code\u003e\nfield into a \u003ccode\u003eConfigMap\u003c/code\u003e.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: application-user-data\nspec:\n name: doc-example-bucket\n---\napiVersion: v1\nkind: ConfigMap\nmetadata:\n name: application-user-data-cm\ndata: {}\n---\napiVersion: services.k8s.aws/v1alpha1\nkind: FieldExport\nmetadata:\n name: export-user-data-bucket\nspec: \n to:\n name: application-user-data-cm # Matches the ConfigMap we created above\n kind: configmap\n from:\n path: \u0026quot;.status.location\u0026quot;\n resource:\n group: s3.services.k8s.aws\n kind: Bucket\n name: application-user-data\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApplying this manifest to the cluster will:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003eCreate a new S3 bucket called \u003ccode\u003edoc-example-bucket\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCreate a \u003ccode\u003eConfigMap\u003c/code\u003e called \u003ccode\u003eapplication-user-data-cm\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eCreate a \u003ccode\u003eFieldExport\u003c/code\u003e called \u003ccode\u003eexport-user-data-bucket\u003c/code\u003e that will export the\n\u003ccode\u003e.status.location\u003c/code\u003e path from the bucket into the ConfigMap\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eAfter the reconciler has created the bucket, the \u003ccode\u003eapplication-user-data-cm\u003c/code\u003e\n\u003ccode\u003eConfigMap\u003c/code\u003e looks like the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: ConfigMap\nmetadata:\n name: application-user-data-cm\n namespace: default\ndata:\n default.export-user-data-bucket: http://doc-example-bucket.s3.amazonaws.com/\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe \u003ccode\u003eConfigMap\u003c/code\u003e data contains a new key-value pair. The key is the namespace and\nname of the \u003ccode\u003eFieldExport\u003c/code\u003e that created it, and the value is the resolved value\nfrom the resourc. This value can then be included as an environment variable in\na pod like so:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Pod\nmetadata:\n name: my-application\nspec:\n containers:\n - name: field-export-demo-container\n image: registry.k8s.io/busybox\n command: [ \u0026quot;/bin/sh\u0026quot;, \u0026quot;-c\u0026quot;, \u0026quot;env\u0026quot; ]\n env:\n - name: USER_DATA_BUCKET_LOCATION\n valueFrom:\n configMapKeyRef:\n name: application-user-data-cm # The ConfigMap that we created earlier\n key: \u0026quot;default.export-user-data-bucket\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eLooking at the container logs, you can see the \u003ccode\u003eUSER_DATA_BUCKET_LOCATION\u003c/code\u003e\nenvironment is set with the value from the \u003ccode\u003eConfigMap\u003c/code\u003e:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eUSER_DATA_BUCKET_LOCATION=http://doc-example-bucket.s3.amazonaws.com/\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eFor a more comprehensive example of using \u003ccode\u003eFieldExport\u003c/code\u003e with multiple fields,\ncheck out the \u003ca href="../../tutorials/rds-example/"\u003eDeploy PostgreSQL + MariaDB Instances Using the ACK RDS\nController tutorial\u003c/a\u003e\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n \u003ccode\u003eFieldExport\u003c/code\u003e RBAC permissions\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThe ACK controller will fetch the source path from the ACK resource assuming\nits service account has the RBAC permissions to read that type of resource. If a\nuser has the privileges to create a \u003ccode\u003eFieldExport\u003c/code\u003e resource, it is possible that\nthey can create one which fetches fields from a resource they do not have RBAC\npermissions to read directly. This could potentially expose that resource\u0026rsquo;s\nproperties to the unprivileged user.\u003c/p\u003e\n\u003cp\u003eTo mitigate this problem, the ACK controller will only export fields from\nresources that exist in the same namespace as the \u003ccode\u003eFieldExport\u003c/code\u003e resource\nrequesting it.\u003c/p\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n'}).add({id:39,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/adopted-resource/",title:"Adopting Existing AWS Resources",description:"Adopting Existing AWS Resources",content:'\u003cp\u003eThe ACK controllers are intended to manage the complete lifecycle of an AWS\nresource, from creation through deletion. However, you may already be\nmanaging those resources using other tools - such as CloudFormation or\nTerraform. Migrating to ACK could be time-consuming to redeclare all resources\nas YAML, or even cause you to lose the state of the application if parts of the\nsystem are recreated. The ACK \u003ccode\u003eAdoptedResource\u003c/code\u003e custom resource was designed to\nhelp migrate these AWS resources to be managed by an ACK controller in your Kubernetes\ncluster without having to define the full YAML spec or needing to delete and\nre-create the resource.\u003c/p\u003e\n\u003cp\u003eTo adopt an AWS resource, create an \u003ccode\u003eAdoptedResource\u003c/code\u003e custom\nresource that specifies the unique identifier for the AWS resource and a target\nK8s object. After applying this custom resource to the cluster, the ACK\ncontroller will describe the AWS resource and create the associated ACK resource\ninside the cluster - with a complete spec and status. The ACK controller will\nthen treat the newly-created ACK resource like any other.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers ship with the same \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD. Every controller\ncontains the logic for adopting resources from its particular service. That is,\nthe S3 controller understands how to adopt all S3 resources. If you don\u0026rsquo;t have a\nparticular service controller installed, and try to adopt a resource from that\nservice, the \u003ccode\u003eAdoptedResource\u003c/code\u003e CR will have no effect.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cp\u003eThe full spec for the \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD is located \u003ca href="https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/adoptedresource/"\u003ein the API\nreference\u003c/a\u003e. The spec contains two parts: the AWS resource reference and\nthe Kubernetes target.\u003c/p\u003e\n\u003ch3 id="aws-resource"\u003eAWS Resource\u003c/h3\u003e\n\u003cp\u003eThe AWS resource reference requires the unique identifier for the object, either\nas an ARN or as the name or ID of the object. Which of these is required depends\non the service and the particular resource.\nYou can find which field is required\nby finding the unique identifier field used by the \u003ccode\u003eDescribe*\u003c/code\u003e, \u003ccode\u003eList*\u003c/code\u003e, or \u003ccode\u003eGet*\u003c/code\u003e API\ncalls for that resource.\u003c/p\u003e\n\u003cp\u003eIf we were adopting for an IAM Role, since the \u003ca href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetRole.html"\u003eIAM Get Role API\u003c/a\u003e call requires \u003ccode\u003eRoleName\u003c/code\u003e, you should set \u003ccode\u003e.spec.aws.nameOrId\u003c/code\u003e to the name of the role you would like to adopt.\u003c/p\u003e\n\u003cp\u003eIf we were adopting for an IAM Policy, since the \u003ca href="https://docs.aws.amazon.com/IAM/latest/APIReference/API_GetPolicy.html"\u003eIAM Get Policy API\u003c/a\u003e call requires \u003ccode\u003ePolicyArn\u003c/code\u003e, you should set \u003ccode\u003e.spec.aws.arn\u003c/code\u003e to the ARN of the policy you would like to adopt.\u003c/p\u003e\n\u003ch3 id="kubernetes-target"\u003eKubernetes Target\u003c/h3\u003e\n\u003cp\u003eThe Kubernetes target requires the \u003ccode\u003egroup\u003c/code\u003e and \u003ccode\u003ekind\u003c/code\u003e - these identify from\nwhich service and resource you wish to adopt. For example, to adopt an S3\nbucket, you would specify a \u003ccode\u003egroup\u003c/code\u003e of \u003ccode\u003es3.services.k8s.aws\u003c/code\u003e and a \u003ccode\u003ekind\u003c/code\u003e of\n\u003ccode\u003eBucket\u003c/code\u003e. The Kubernetes target also allows you to override the \u003ccode\u003emetadata\u003c/code\u003e for\nthe object that is created. By default, all resources created through an\n\u003ccode\u003eAdoptedResource\u003c/code\u003e will have the same \u003ccode\u003emetadata.name\u003c/code\u003e as the \u003ccode\u003eAdoptedResource\u003c/code\u003e\nthat created it.\u003c/p\u003e\n\u003ch3 id="example"\u003eExample\u003c/h3\u003e\n\u003cp\u003eBelow is an example of adopting an S3 bucket, overriding the name and namespace\nof the target K8s object and adding a label.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: services.k8s.aws/v1alpha1\nkind: AdoptedResource\nmetadata:\n name: adopt-my-existing-bucket\nspec: \n aws:\n nameOrID: example-bucket\n kubernetes:\n group: s3.services.k8s.aws\n kind: Bucket\n metadata:\n name: my-existing-bucket\n namespace: default\n labels:\n app: foo\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="additional-keys"\u003eAdditional Keys\u003c/h3\u003e\n\u003cp\u003eSome AWS resources cannot be defined using only a single unique identifier. For\nAPIs where we need to provide multiple identifiers, the \u003ccode\u003eAdoptedResource\u003c/code\u003e spec\ncontains a field called \u003ccode\u003eaws.additionalKeys\u003c/code\u003e which allows for any number of\narbitrary key-value pairs required to define the multiple identifier keys. When\nadopting a resource with multiple identifiers, provide the \u003cem\u003emost specific\u003c/em\u003e\nidentifier in the \u003ccode\u003enameOrID\u003c/code\u003e field. Then for each additional identifier, set the\nname of the key in \u003ccode\u003eadditionalKeys\u003c/code\u003e to be the name in the ACK spec or status for\nthat field, and the value to be the actual identifier value.\u003c/p\u003e\n\u003cp\u003eFor example, the \u003ca href="https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/integration/#spec"\u003e\u003ccode\u003eIntegration\u003c/code\u003e\u003c/a\u003e resource in AWS API Gateway\nV2 is uniquely identified by both an \u003ccode\u003eintegrationID\u003c/code\u003e and an \u003ccode\u003eapiID\u003c/code\u003e. The API\nrequires both of these features to \u003ca href="https://docs.aws.amazon.com/sdk-for-go/api/service/apigatewayv2/#GetIntegrationInput"\u003edescribe an integration\u003c/a\u003e. In\nthis case, we would provide the \u003ccode\u003eintegrationID\u003c/code\u003e for the \u003ccode\u003enameOrID\u003c/code\u003e field - since\nit is unique for every API Gateway v2 \u003ccode\u003eAPI\u003c/code\u003e object. Then to provide the \u003ccode\u003eapiID\u003c/code\u003e,\nwe add a key of \u003ccode\u003eapiID\u003c/code\u003e in the \u003ccode\u003eadditionalKeys\u003c/code\u003e and the value as the API ID for\nthe resource we want to adopt. The full spec of the \u003ccode\u003eAdoptedResource\u003c/code\u003e would look\nlike the following:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: services.k8s.aws/v1alpha1\nkind: AdoptedResource\nmetadata:\n name: adopt-my-existing-integration\nspec: \n aws:\n nameOrID: integration-id-123456789012\n additionalKeys:\n apiID: api-id-123456789012\n kubernetes:\n group: apigatewayv2.services.k8s.aws\n kind: Integration\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:40,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/ack-tags/",title:"Managing Tags on your AWS Resources",description:"Managing Tags on your AWS Resources",content:'\u003cp\u003eMost AWS resources can have one or more Tags, defined as simple key/value\npairs, associated with them. These Tags allow you to organize and categorize\nyour AWS resources for accounting and informational purposes. ACK custom\nresources (CRs) that support Tags will have a \u003cem\u003eSpec.Tags\u003c/em\u003e field that\nstores user-defined key/value pairs. In addition to user-defined Tags,\nACK also supports a set of default tags, which are Tags that the ACK\ncontroller will automatically ensure are on all resources that it manages.\u003c/p\u003e\n\u003cp\u003eThe two default tags added by ACK controller are \u003ccode\u003eservices.k8s.aws/controller-version\u003c/code\u003e\nand \u003ccode\u003eservices.k8s.aws/namespace\u003c/code\u003e. The \u003cem\u003econtroller-version\u003c/em\u003e tag value is the name of\ncorresponding AWS service and version for that controller(Ex: \u003ccode\u003es3-0.1.3\u003c/code\u003e).\nAnd the \u003cem\u003enamespace\u003c/em\u003e tag value is the Kubernetes namespace for the ACK\nresource.(Ex: \u003ccode\u003edefault\u003c/code\u003e)\u003c/p\u003e\n\u003cp\u003eWhen tags are already present inside the Kubernetes custom resource\u0026rsquo;s \u003ccode\u003eSpec.Tags\u003c/code\u003e,\nACK default tags are added to the AWS resource\u0026rsquo;s tags collection along with those\ntags from \u003ccode\u003eSpec.Tags\u003c/code\u003e. Priority is given to \u003ccode\u003eSpec.Tags\u003c/code\u003e when there is a\nconflict between ACK default tag keys and tag keys in \u003ccode\u003eSpec.Tags\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="example"\u003eExample\u003c/h2\u003e\n\u003cp\u003eFor a resource manifest like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: ecr.services.k8s.aws/v1alpha1\nkind: Repository\nmetadata:\n name: my-ack-tagging-repo\n namespace: default\nspec:\n name: my-ack-tagging-repo\n tags:\n - key: \u0026quot;first\u0026quot;\n value: \u0026quot;1\u0026quot;\n - key: \u0026quot;second\u0026quot;\n value: \u0026quot;2\u0026quot;\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eThe sample response for \u003ccode\u003elist-tags-for-resource\u003c/code\u003e will look like\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws ecr list-tags-for-resource --resource-arn arn:aws:ecr:us-west-2:************:repository/my-ack-tagging-repo\n{\n \u0026quot;tags\u0026quot;: [\n {\n \u0026quot;Key\u0026quot;: \u0026quot;services.k8s.aws/controller-version\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;ecr-0.1.4\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;first\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;1\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;services.k8s.aws/namespace\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;default\u0026quot;\n },\n {\n \u0026quot;Key\u0026quot;: \u0026quot;second\u0026quot;,\n \u0026quot;Value\u0026quot;: \u0026quot;2\u0026quot;\n }\n ]\n}\n\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="configuring-default-tags"\u003eConfiguring Default Tags\u003c/h2\u003e\n\u003cp\u003eThe default tags added by ACK controllers are configurable during controller\ninstallation.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo remove the ACK default tags, set the \u003ccode\u003eresourceTags\u003c/code\u003e Helm value to be \u003ccode\u003e{}\u003c/code\u003e inside\n\u003cem\u003evalues.yaml\u003c/em\u003e file or use \u003ccode\u003e--set \'resourceTags={}\'\u003c/code\u003e during helm chart installation.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo override the default ACK tags, include each tag \u0026ldquo;key=value\u0026rdquo; pair as a list under\n\u003ccode\u003eresourceTags\u003c/code\u003e in \u003cem\u003evalues.yaml\u003c/em\u003e file\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresourceTags:\n- tk1=tv1\n- tk2=tv2\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou can also override default ACK tags using \u003ccode\u003e--set \'resourceTags=[tk1=tv1, tk2=tv2]\'\u003c/code\u003e\nduring helm chart installation.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eACK supports variable expansion inside tag values for following variables:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e%CONTROLLER_SERVICE%\u003c/li\u003e\n\u003cli\u003e%CONTROLLER_VERSION%\u003c/li\u003e\n\u003cli\u003e%K8S_NAMESPACE%\u003c/li\u003e\n\u003cli\u003e%K8S_RESOURCE_NAME%\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eA custom resource tag \u003ccode\u003ek8s-name=%K8S_RESOURCE_NAME\u003c/code\u003e in above ecr repository example\nwould be expanded to \u0026ldquo;k8s-name=my-ack-tagging-repo\u0026rdquo;\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:41,href:"https://aws-controllers-k8s.github.io/community/docs/contributor-docs/release/",title:"Release",description:"The release process for ACK service controller",content:'\u003cp\u003eRemember that there is no single ACK binary. Rather, when we build a release\nfor ACK, that release is for one or more individual ACK service controllers\nbinaries, each of which are installed separately.\u003c/p\u003e\n\u003cp\u003eThis documentation covers the steps involved for officially publishing\na ACK service controller\u0026rsquo;s release artifacts.\u003c/p\u003e\n\u003cp\u003eOnce ACK service controller changes are tested by the service team and they wish to\nrelease latest artifacts, service team only needs to create a new release for service-controller\ngithub repository with a semver tag (Ex: \u003ccode\u003e0.0.1\u003c/code\u003e).\nSteps below show how to create a new release with semver tag.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Semver\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n For more details on semantic versioning(semver), please read our \u003ca href="../../community/releases/"\u003erelease phase guide\u003c/a\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eOnce the git repository is tagged with semver, a postsubmit prowjob builds\ncontainer image for ACK service controller and publish to public ecr repository \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/controller\u003c/code\u003e.\nSame prowjob also publishes the Helm charts for the ACK service controller to\npublic ecr repository \u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/chart\u003c/code\u003e.\u003c/p\u003e\n\u003ch2 id="what-is-a-release-exactly"\u003eWhat is a release exactly?\u003c/h2\u003e\n\u003cp\u003eA \u0026ldquo;release\u0026rdquo; is the combination of a Git tag containing a SemVer version tag\nagainst this source repository and the collection of \u003cem\u003eartifacts\u003c/em\u003e that allow the\nindividual ACK service controllers included in that Git commit to be easily\ninstalled via Helm.\u003c/p\u003e\n\u003cp\u003eThe Git tag points at a specific Git commit referencing the exact source code\nthat comprises the ACK service controllers in that \u0026ldquo;release\u0026rdquo;.\u003c/p\u003e\n\u003cp\u003eThe release artifacts include the following for one or more service\ncontrollers:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eContainer image\u003c/li\u003e\n\u003cli\u003eHelm chart\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe container image is built and pushed with an image tag that indicates the\nrelease version for the controller along with the AWS service. For example,\nassume a release semver tag of \u003ccode\u003e0.1.0\u003c/code\u003e that includes service controllers for\nS3 and SNS. There would be two container images built for this release, one each\ncontaining the ACK service controllers for S3 and SNS. The container images would\nhave the following image tags: \u003ccode\u003es3-0.1.0\u003c/code\u003e and \u003ccode\u003esns-0.1.0\u003c/code\u003e. Note\nthat the full image name would be\n\u003ccode\u003epublic.ecr.aws/aws-controllers-k8s/s3-controller:0.1.0\u003c/code\u003e\u003c/p\u003e\n\u003cp\u003eThe Helm chart artifact can be used to install the ACK service controller as a\nKubernetes Deployment; the Deployment\u0026rsquo;s Pod image will refer to the exact\ncontainer image tag matching the release tag.\u003c/p\u003e\n\u003ch2 id="release-steps"\u003eRelease steps\u003c/h2\u003e\n\u003col start="0"\u003e\n\u003cli\u003eRebase $SERVICE-controller repo with latest code:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd $GOSRC/github.com/aws-controllers-k8s\nexport SERVICE=s3\ncd $SERVICE-controller\ngit fetch --all --tags\n# Optionally fetch and rebase the latest code generator\ncd ../code-generator\ngit checkout main \u0026amp;\u0026amp; git fetch --all --tags \u0026amp;\u0026amp; git rebase upstream/main\n\u003c/code\u003e\u003c/pre\u003e\n\u003col\u003e\n\u003cli\u003eNavigate to $SERVICE-controller repo and check out a git branch for your release:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../$SERVICE-controller\nexport RELEASE_VERSION=v0.0.1\ngit checkout -b release-$RELEASE_VERSION\ngit branch --set-upstream-to=origin/main release-$RELEASE_VERSION\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="2"\u003e\n\u003cli\u003eNavigate to code-generator repo and build the release artifacts for the $SERVICE-controller:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../code-generator\nmake build-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="3"\u003e\n\u003cli\u003eNavigate to $SERVICE-controller repo to review the release artifacts that were built for each service by looking in the \u003ccode\u003ehelm\u003c/code\u003e\ndirectory:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ecd ../$SERVICE-controller\ngit diff\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n When you run \u003ccode\u003emake build-controller\u003c/code\u003e for a service, it will overwrite any\nHelm chart files that had previously been generated in the \u003ccode\u003e$SERVICE-controller/helm\u003c/code\u003e\ndirectory with files that refer to the container image with an image tag\nreferring to the release you\u0026rsquo;ve just built artifacts for.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003col start="4"\u003e\n\u003cli\u003eCommit the generated release artifacts and create a pull request:\u003c/li\u003e\n\u003c/ol\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003egit commit -a -m \u0026quot;release artifacts for release $RELEASE_VERSION\u0026quot;\ngit push origin release-$RELEASE_VERSION\n\u003c/code\u003e\u003c/pre\u003e\n\u003col start="5"\u003e\n\u003cli\u003e\n\u003cp\u003eGet your pull request reviewed and merged. After merge, tag is automatically applied and pushed.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003e\u003ccode\u003egit tag\u003c/code\u003e operation (applied automatically in last step) triggers a postsubmit prowjob which builds container image and then publishes\nboth container image and Helm chart to public ECR repository.\nService team can see the release prowjobs, their status and logs at https://prow.ack.aws.dev/\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n'}).add({id:42,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/deletion-policy/",title:"Retain AWS Resources after CR Deletion",description:"Using the ACK deletion policy configuration",content:'\u003cp\u003eThe ACK controllers are designed to create, update and delete AWS resources\nfollowing the lifecycle of their respective Kubernetes custom resources. As a\nresult, when deleting an ACK resource, the underlying AWS resource is first\ndeleted before deleting its Kubernetes custom resource. This behavior is\nexpected so that users can delete AWS resources using the same Kubernetes APIs\nas they used to create them.\u003c/p\u003e\n\u003cp\u003eThere are some cases where a user wants to leave the underlying AWS resource\nintact, but still delete the resource from Kubernetes. For example, migrating\nstateful data resources (like S3 buckets or RDS database instances) between\nKubernetes installations or removing a resource from the control of an ACK\ncontroller without deleting the resource altogether.\u003c/p\u003e\n\u003cp\u003eAll ACK controllers support \u0026ldquo;deletion policy\u0026rdquo; configuration, which lets the\ncontroller know which resources should be deleted from AWS (or left untouched)\nbefore deleting their K8s resources. The controller looks for deletion policy configuration\nin the following order:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eWithin an ACK resource annotation as \u003ccode\u003eservices.k8s.aws/deletion-policy\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eWithin a \u003ccode\u003eNamespace\u003c/code\u003e annotation as\n\u003ccode\u003e{service}.services.k8s.aws/deletion-policy\u003c/code\u003e\u003c/li\u003e\n\u003cli\u003eWithin the controller command-line using the \u003ccode\u003e--deletion-policy\u003c/code\u003e argument\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eEach of these configuration options supports the following values:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003edelete\u003c/code\u003e - \u003cstrong\u003e(Default)\u003c/strong\u003e Deletes the resource from AWS before deleting it from\nK8s\u003c/li\u003e\n\u003cli\u003e\u003ccode\u003eretain\u003c/code\u003e - Keeps the AWS resource intact before deleting it from K8s\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="configuring-the-deletion-policy"\u003eConfiguring the deletion policy\u003c/h2\u003e\n\u003ch3 id="using-helm-values"\u003eUsing Helm values\u003c/h3\u003e\n\u003cp\u003eTo set a controller-wide deletion policy, which will apply to all ACK resources\nowned by the ACK controller, you can set the \u003ccode\u003edeletionPolicy\u003c/code\u003e Helm chart value.\nThis Helm chart value accepts the same values as the deletion policy\nconfiguration described above.\u003c/p\u003e\n\u003cp\u003eFor example, to retain all AWS resources when installing the Helm chart through\nthe Helm CLI: \u003ccode\u003ehelm install ... --set=deletionPolicy=retain\u003c/code\u003e\u003c/p\u003e\n\u003ch3 id="for-all-resources-within-a-namespace"\u003eFor all resources within a Namespace\u003c/h3\u003e\n\u003cp\u003eTo set the deletion policy for all resources within a namespace (only for a\nsingle service), you can add an annotation to the \u003ccode\u003eNamespace\u003c/code\u003e object itself.\u003c/p\u003e\n\u003cp\u003eFor example, to set all S3 resources to be retained within the namespace:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: v1\nkind: Namespace\nmetadata:\n annotations:\n s3.services.k8s.aws/deletion-policy: retain\n name: retain-s3-namespace\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="for-a-single-ack-resource"\u003eFor a single ACK resource\u003c/h3\u003e\n\u003cp\u003eIf you want to just retain a single specific resource, you can override the\ndefault behavior by setting an annotation directly onto the resource.\u003c/p\u003e\n\u003cp\u003eFor example, to retain a specific S3 bucket:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiVersion: s3.services.k8s.aws/v1alpha1\nkind: Bucket\nmetadata:\n name: retained-bucket\n annotations:\n services.k8s.aws/deletion-policy: retain\nspec:\n name: my-retained-bucket\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e\u003cem\u003eNote: The key for annotating a single resource is not the same as the key when\nannotating a namespace. You do not need to provide the name of the service as a\nprefix for a single resource.\u003c/em\u003e\u003c/p\u003e\n'}).add({id:43,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/openshift/",title:"Red Hat OpenShift",description:"Configuration details specific to OpenShift clusters",content:'\u003cp\u003eConfiguration for ACK controllers in an OpenShift cluster.\u003c/p\u003e\n\u003ch2 id="pre-installation-instructions"\u003ePre-installation instructions\u003c/h2\u003e\n\u003cp\u003eWhen ACK service controllers are installed via OperatorHub, a cluster administrator will need to perform the following pre-installation steps to provide the controller any credentials and authentication context it needs to interact with the AWS API.\u003c/p\u003e\n\u003cp\u003eConfiguration and authentication in OpenShift requires the use of IAM users and policies. Authentication credentials are set inside a \u003ccode\u003eSecret\u003c/code\u003e (optional if utilizing \u003ca href="../irsa"\u003eIRSA\u003c/a\u003e) before installation of the controller.\u003c/p\u003e\n\u003ch3 id="step-1-create-the-installation-namespace"\u003eStep 1: Create the installation namespace\u003c/h3\u003e\n\u003cp\u003eIf the default \u003ccode\u003eack-system\u003c/code\u003e namespace does not exist already, create it:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc new-project ack-system\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-2-bind-an-aws-iam-principal-to-a-service-user-account"\u003eStep 2: Bind an AWS IAM principal to a service user account\u003c/h3\u003e\n\u003cp\u003eCreate a user with the \u003ccode\u003eaws\u003c/code\u003e CLI (named \u003ccode\u003eack-elasticache-service-controller\u003c/code\u003e in our example):\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-user --user-name ack-elasticache-service-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eEnable programmatic access for the user you just created:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam create-access-key --user-name ack-elasticache-service-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eYou should see output with important credentials:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-json"\u003e{\n \u0026quot;AccessKey\u0026quot;: {\n \u0026quot;UserName\u0026quot;: \u0026quot;ack-elasticache-service-controller\u0026quot;,\n \u0026quot;AccessKeyId\u0026quot;: \u0026quot;00000000000000000000\u0026quot;,\n \u0026quot;Status\u0026quot;: \u0026quot;Active\u0026quot;,\n \u0026quot;SecretAccessKey\u0026quot;: \u0026quot;abcdefghIJKLMNOPQRSTUVWXYZabcefghijklMNO\u0026quot;,\n \u0026quot;CreateDate\u0026quot;: \u0026quot;2021-09-30T19:54:38+00:00\u0026quot;\n }\n}\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eSave or note \u003ccode\u003eAccessKeyId\u003c/code\u003e and \u003ccode\u003eSecretAccessKey\u003c/code\u003e for later use.\u003c/p\u003e\n\u003cp\u003eEach service controller repository provides a recommended policy ARN for use with the controller. For an example, see the recommended policy for \u003ca href="https://github.com/aws-controllers-k8s/elasticache-controller/blob/main/config/iam/recommended-policy-arn"\u003eElasticache here\u003c/a\u003e.\u003c/p\u003e\n\u003cp\u003eAttach the recommended policy to the user we created in the previous step:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eaws iam attach-user-policy \\\n --user-name ack-elasticache-service-controller \\\n --policy-arn \'arn:aws:iam::aws:policy/AmazonElastiCacheFullAccess\'\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-3-create-ack-service-user-config-and-ack-service-user-secrets-for-authentication"\u003eStep 3: Create \u003ccode\u003eack-$SERVICE-user-config\u003c/code\u003e and \u003ccode\u003eack-$SERVICE-user-secrets\u003c/code\u003e for authentication\u003c/h3\u003e\n\u003cp\u003eEnter the \u003ccode\u003eack-system\u003c/code\u003e namespace. Create a file, \u003ccode\u003econfig.txt\u003c/code\u003e, with the following variables, leaving \u003ccode\u003eACK_WATCH_NAMESPACE\u003c/code\u003e blank so the controller can properly watch all namespaces, and change any other values to suit your needs:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eACK_ENABLE_DEVELOPMENT_LOGGING=true\nACK_LOG_LEVEL=debug\nACK_WATCH_NAMESPACE=\nAWS_REGION=us-west-2\nAWS_ENDPOINT_URL=\nACK_RESOURCE_TAGS=hellofromocp\nENABLE_LEADER_ELECTION=true\nLEADER_ELECTION_NAMESPACE=\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eNow use \u003ccode\u003econfig.txt\u003c/code\u003e to create a \u003ccode\u003eConfigMap\u003c/code\u003e in your OpenShift cluster:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=elasticache\n\noc create configmap \\\n--namespace ack-system \\\n--from-env-file=config.txt ack-$SERVICE-user-config\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-info"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Note\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n \u003cp\u003eThe \u003ccode\u003eSecret\u003c/code\u003e is optional if \u003ca href="../irsa"\u003eIRSA\u003c/a\u003e is intended to be used. In order to utilize IRSA, STS would have needed to be configured during cluster installation.\nThere are two ways to provision an OpenShift cluster to utilize STS:\u003c/p\u003e\n\u003col\u003e\n\u003cli\u003e\u003ca href="https://docs.openshift.com/container-platform/latest/authentication/managing_cloud_provider_credentials/cco-mode-sts.html"\u003eOpenShift Container Platform using manual mode for STS\u003c/a\u003e\u003c/li\u003e\n\u003cli\u003e\u003ca href="https://docs.openshift.com/rosa/rosa_install_access_delete_clusters/rosa-sts-creating-a-cluster-quickly.html"\u003eRed Hat OpenShift Service on AWS\u003c/a\u003e\u003c/li\u003e\n\u003c/ol\u003e\n \u003c/div\u003e\n\u003c/div\u003e\n\u003cp\u003eSave another file, \u003ccode\u003esecrets.txt\u003c/code\u003e, with the following authentication values, which you should have saved from earlier when you created your user\u0026rsquo;s access keys:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eAWS_ACCESS_KEY_ID=00000000000000000000\nAWS_SECRET_ACCESS_KEY=abcdefghIJKLMNOPQRSTUVWXYZabcefghijklMNO\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eUse \u003ccode\u003esecrets.txt\u003c/code\u003e to create a \u003ccode\u003eSecret\u003c/code\u003e in your OpenShift cluster:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc create secret generic \\\n--namespace ack-system \\\n--from-env-file=secrets.txt ack-$SERVICE-user-secrets\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eDelete \u003ccode\u003econfig.txt\u003c/code\u003e and \u003ccode\u003esecrets.txt\u003c/code\u003e.\u003c/p\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Warning\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n If you change the name of either the \u003ccode\u003eConfigMap\u003c/code\u003e or the \u003ccode\u003eSecret\u003c/code\u003e from the values given above, i.e. \u003ccode\u003eack-$SERVICE-user-config\u003c/code\u003e and \u003ccode\u003eack-$SERVICE-user-secrets\u003c/code\u003e, then installations from OperatorHub will not function properly. The Deployment for the controller is preconfigured for these key values.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="step-4-optional-apply-additional-custom-resource-definitionscrd"\u003eStep 4 (Optional): Apply Additional Custom Resource Definitions(CRD)\u003c/h3\u003e\n\u003cp\u003eTo prevent CRD installation conflicts for CRDs shared across multiple AWS Controllers for Kubernetes,\nthe \u003ca href="../../../reference/common/v1alpha1/adoptedresource/"\u003eAdoptedResource\u003c/a\u003e and \u003ca href="../../../reference/common/v1alpha1/fieldexport/"\u003eFieldExport\u003c/a\u003e CRDs are not included in the OpenShift Embedded OperatorHub.\nThese must be installed manually by a cluster administrator before any controller is installed by running the following commands:\u003c/p\u003e\n\u003cp\u003eApply the \u003ccode\u003eAdoptedResource\u003c/code\u003e CRD\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc apply -f https://raw.githubusercontent.com/aws-controllers-k8s/runtime/main/config/crd/bases/services.k8s.aws_adoptedresources.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003eApply the \u003ccode\u003eFieldExport\u003c/code\u003e CRD\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc apply -f https://raw.githubusercontent.com/aws-controllers-k8s/runtime/main/config/crd/bases/services.k8s.aws_fieldexports.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="step-5-install-the-controller"\u003eStep 5: Install the controller\u003c/h3\u003e\n\u003cp\u003eFollow the instructions for \u003ca href="../install/#install-an-ack-service-controller-with-operatorhub-in-red-hat-openshift"\u003einstalling the controller using OperatorHub\u003c/a\u003e.\u003c/p\u003e\n\u003ch2 id="additional-uninstallation-steps"\u003eAdditional uninstallation steps\u003c/h2\u003e\n\u003cp\u003ePerform the following cleanup steps in addition to the steps in \u003ca href="../cleanup"\u003eUninstall an ACK Controller\u003c/a\u003e.\u003c/p\u003e\n\u003ch3 id="uninstall-the-ack-controller"\u003eUninstall the ACK Controller\u003c/h3\u003e\n\u003cp\u003eNavigate in the OpenShift dashboard to the OperatorHub page and search for the controller name. Select \u003cstrong\u003eUninstall\u003c/strong\u003e to remove the controller.\u003c/p\u003e\n\u003ch3 id="delete-configmap"\u003eDelete ConfigMap\u003c/h3\u003e\n\u003cp\u003eDelete the following \u003ccode\u003eConfigMap\u003c/code\u003e you created in pre-installation:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc delete configmap ack-$SERVICE-user-config\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch3 id="delete-user-secret"\u003eDelete user Secret\u003c/h3\u003e\n\u003cp\u003eDelete the folllowing \u003ccode\u003eSecret\u003c/code\u003e you created in pre-installation:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eoc delete secret ack-$SERVICE-user-secrets\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="next-steps"\u003eNext Steps\u003c/h2\u003e\n\u003cp\u003eAfter you install the controller, you can follow the \u003ca href="../cross-account-resource-management"\u003eCross Account Resource Management\u003c/a\u003e instructions to manage resources in multiple AWS accounts.\u003c/p\u003e\n'}).add({id:44,href:"https://aws-controllers-k8s.github.io/community/docs/user-docs/cleanup/",title:"Uninstall an ACK Controller",description:"Uninstall an ACK Controller",content:'\u003cp\u003eUse the \u003ccode\u003ehelm uninstall\u003c/code\u003e command to uninstall an ACK service controller:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\n\n# Uninstall the ACK service controller with Helm\nhelm uninstall -n $ACK_SYSTEM_NAMESPACE ack-$SERVICE-controller\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-crds"\u003eDelete CRDs\u003c/h2\u003e\n\u003ch3 id="delete-individual-crds"\u003eDelete individual CRDS\u003c/h3\u003e\n\u003cp\u003eIf you have multiple controllers installed and only want to delete CRDs related to a specific resource, use the \u003ccode\u003ekubectl delete\u003c/code\u003e command to delete the CRDs with the the service name prefix.\u003c/p\u003e\n\u003cp\u003eFor example, use the following commands to delete the CRD for Amazon S3 Buckets:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport CHART_EXPORT_PATH=/tmp/chart\n\n# Delete an individual CRD\nkubectl delete -f $CHART_EXPORT_PATH/$SERVICE-chart/crds/s3.services.k8s.aws_buckets.yaml\n\u003c/code\u003e\u003c/pre\u003e\n\u003cdiv class="hint d-flex flex-column border-start my-4 border-4 hint-warning"\u003e\n \u003cdiv class="hint-title p-2 flex flex-row flex-items-center"\u003e\n Check for CRDs that are common across services\n \u003c/div\u003e\n \u003cdiv class="hint-body p-2 small"\u003e\n There are a few custom resource definitions (CRDs) that are common across services. If you have multiple controllers installed, you should not delete the common CRDs unless you are uninstalling all of the controllers.\n \u003c/div\u003e\n\u003c/div\u003e\n\u003ch3 id="delete-all-crds"\u003eDelete all CRDs\u003c/h3\u003e\n\u003cp\u003eIf you are sure that you would like to delete all CRDs, use the following commands:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003eexport SERVICE=s3\nexport CHART_EXPORT_PATH=/tmp/chart\n\n# Delete all CRDs\nkubectl delete -f $CHART_EXPORT_PATH/$SERVICE-chart/crds\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="verify-helm-charts-were-deleted"\u003eVerify Helm charts were deleted\u003c/h2\u003e\n\u003cp\u003eVerify that the Helm chart for your ACK service controller was deleted with the following command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ehelm ls -n $ACK_SYSTEM_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-namespaces"\u003eDelete namespaces\u003c/h2\u003e\n\u003cp\u003eDelete a specified namespace with the \u003ccode\u003ekubectl delete namespace\u003c/code\u003e command:\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete namespace $ACK_SYSTEM_NAMESPACE\n\u003c/code\u003e\u003c/pre\u003e\n\u003ch2 id="delete-configmap"\u003eDelete ConfigMap\u003c/h2\u003e\n\u003cp\u003eIf you used \u003ca href="../cross-account-resource-management/"\u003ecross account resource management\u003c/a\u003e, delete the \u003ccode\u003eConfigMap\u003c/code\u003e you created.\u003c/p\u003e\n\u003cpre\u003e\u003ccode class="language-bash"\u003ekubectl delete -n ack-system configmap ack-role-account-map\n\u003c/code\u003e\u003c/pre\u003e\n'}).add({id:45,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/accessentry/",title:"AccessEntry",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#AccessEntry"\u003eeks-controller/apis/v1alpha1#AccessEntry\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessEntry\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessEntryList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccessentries\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccessentry\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn access entry allows an IAM principal (user or role) to access your cluster.\nAccess entries can replace the need to maintain the aws-auth ConfigMap for\nauthentication. For more information about access entries, see Access entries\n(https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html) in\nthe Amazon EKS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPolicies:\n accessScope: \n namespaces:\n - string\n type: string\n policyARN: string\nclusterName: string\nclusterRef: \n from: \n name: string\nkubernetesGroups:\n- string\nprincipalARN: string\ntags: {}\ntype: string\nusername: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].accessScope.namespaces\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].accessScope.namespaces.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies.[].policyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe value for name that you\u0026rsquo;ve specified for kind: Group as a subject in\u003cbr/\u003ea Kubernetes RoleBinding or ClusterRoleBinding object. Amazon EKS doesn\u0026rsquo;t\u003cbr/\u003econfirm that the value for name exists in any bindings on your cluster. You\u003cbr/\u003ecan specify one or more names.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKubernetes authorizes the principalArn of the access entry to access any\u003cbr/\u003ecluster objects that you\u0026rsquo;ve specified in a Kubernetes Role or ClusterRole\u003cbr/\u003eobject that is also specified in a binding\u0026rsquo;s roleRef. For more information\u003cbr/\u003eabout creating Kubernetes RoleBinding, ClusterRoleBinding, Role, or ClusterRole\u003cbr/\u003eobjects, see Using RBAC Authorization in the Kubernetes documentation (https://kubernetes.io/docs/reference/access-authn-authz/rbac/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want Amazon EKS to authorize the principalArn (instead of, or in addition\u003cbr/\u003eto Kubernetes authorizing the principalArn), you can associate one or more\u003cbr/\u003eaccess policies to the access entry using AssociateAccessPolicy. If you associate\u003cbr/\u003eany access policies, the principalARN has all permissions assigned in the\u003cbr/\u003eassociated access policies and all permissions in any Kubernetes Role or\u003cbr/\u003eClusterRole objects that the group names are bound to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etype\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of the new access entry. Valid values are Standard, FARGATE_LINUX,\u003cbr/\u003eEC2_LINUX, and EC2_WINDOWS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the principalArn is for an IAM role that\u0026rsquo;s used for self-managed Amazon\u003cbr/\u003eEC2 nodes, specify EC2_LINUX or EC2_WINDOWS. Amazon EKS grants the necessary\u003cbr/\u003epermissions to the node for you. If the principalArn is for any other purpose,\u003cbr/\u003especify STANDARD. If you don\u0026rsquo;t specify a value, Amazon EKS sets the value\u003cbr/\u003eto STANDARD. It\u0026rsquo;s unnecessary to create access entries for IAM roles used\u003cbr/\u003ewith Fargate profiles or managed Amazon EC2 nodes, because Amazon EKS creates\u003cbr/\u003eentries in the aws-auth ConfigMap for the roles. You can\u0026rsquo;t change this value\u003cbr/\u003eonce you\u0026rsquo;ve created the access entry.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you set the value to EC2_LINUX or EC2_WINDOWS, you can\u0026rsquo;t specify values\u003cbr/\u003efor kubernetesGroups, or associate an AccessPolicy to the access entry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username to authenticate to Kubernetes with. We recommend not specifying\u003cbr/\u003ea username and letting Amazon EKS specify it for you. For more information\u003cbr/\u003eabout the value Amazon EKS specifies for you, or constraints before specifying\u003cbr/\u003eyour own username, see Creating access entries (https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html#creating-access-entries)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nmodifiedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp for the last modification to the object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:46,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/accesspoint/",title:"AccessPoint",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#AccessPoint"\u003eefs-controller/apis/v1alpha1#AccessPoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessPoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAccessPointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccesspoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaccesspoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efileSystemID: string\nfileSystemRef: \n from: \n name: string\nposixUser: \n gid: integer\n secondaryGIDs:\n - integer\n uid: integer\nrootDirectory: \n creationInfo: \n ownerGID: integer\n ownerUID: integer\n permissions: string\n path: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the EFS file system that the access point provides access to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe operating system user and group applied to all file system requests made\u003cbr/\u003eusing the access point.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.gid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.secondaryGIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eposixUser.secondaryGIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the directory on the EFS file system that the access point exposes\u003cbr/\u003eas the root directory of your file system to NFS clients using the access\u003cbr/\u003epoint. The clients using the access point can only access the root directory\u003cbr/\u003eand below. If the RootDirectory \u0026gt; Path specified does not exist, Amazon EFS\u003cbr/\u003ecreates it and applies the CreationInfo settings when a client connects to\u003cbr/\u003ean access point. When specifying a RootDirectory, you must provide the Path,\u003cbr/\u003eand the CreationInfo.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon EFS creates a root directory only if you have provided the CreationInfo:\u003cbr/\u003eOwnUid, OwnGID, and permissions for the directory. If you do not provide\u003cbr/\u003ethis information, Amazon EFS does not create the root directory. If the root\u003cbr/\u003edirectory does not exist, attempts to mount using the access point will fail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRequired if the RootDirectory \u0026gt; Path specified does not exist. Specifies\u003cbr/\u003ethe POSIX IDs and permissions to apply to the access point\u0026rsquo;s RootDirectory\u003cbr/\u003e\u0026gt; Path. If the access point root directory does not exist, EFS creates it\u003cbr/\u003ewith these settings when a client connects to the access point. When specifying\u003cbr/\u003eCreationInfo, you must include values for all properties.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon EFS creates a root directory only if you have provided the CreationInfo:\u003cbr/\u003eOwnUid, OwnGID, and permissions for the directory. If you do not provide\u003cbr/\u003ethis information, Amazon EFS does not create the root directory. If the root\u003cbr/\u003edirectory does not exist, attempts to mount using the access point will fail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not provide CreationInfo and the specified RootDirectory does not\u003cbr/\u003eexist, attempts to mount the file system using the access point will fail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.ownerGID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.ownerUID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.creationInfo.permissions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDirectory.path\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eCreates tags associated with the access point. Each tag is a key-value pair,\u003cbr/\u003eeach key must be unique. For more information, see Tagging Amazon Web Services\u003cbr/\u003eresources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag is a key-value pair. Allowed characters are letters, white space, and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003enumbers that can be represented in UTF-8, and the following characters:+\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cul\u003e\n\u003cli\u003e= . _ : /. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPointID: string\nackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlifeCycleState: string\nname: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the access point, assigned by Amazon EFS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the lifecycle phase of the access point.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the access point. This is the value of the Name tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the Amazon Web Services account that owns the access point resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:47,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/acl/",title:"ACL",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#ACL"\u003ememorydb-controller/apis/v1alpha1#ACL\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eACL\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eACLList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eacls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eacl\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Access Control List. You can authenticate users with Access Contol Lists. ACLs enable you to control cluster access by grouping users. These Access control lists are designed as a way to organize access to clusters.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntags:\n- key: string\n value: string\nuserNames:\n- string\nuserRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Access Control List.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of users that belong to the Access Control List.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusters:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nminimumEngineVersion: string\npendingChanges: \n userNamesToAdd:\n - string\n userNamesToRemove:\n - string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of clusters associated with the ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version supported for the ACL\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of updates being applied to the ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userNamesToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:48,href:"https://aws-controllers-k8s.github.io/community/reference/sfn/v1alpha1/activity/",title:"Activity",description:null,content:'\u003cp\u003e\u003ccode\u003esfn.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sfn-controller/apis/v1alpha1#Activity"\u003esfn-controller/apis/v1alpha1#Activity\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eActivity\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eActivityList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eactivities\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eactivity\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the activity to create. This name must be unique for your AWS\u003cbr/\u003eaccount and region for 90 days. For more information, see Limits Related\u003cbr/\u003eto State Machine Executions (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions)\u003cbr/\u003ein the AWS Step Functions Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA name must not contain:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * white space\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * brackets \u0026lt; \u0026gt; { } [ ]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wildcard characters ? *\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * special characters \u0026quot; # % \\ ^\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of tags to add to a resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\u003cbr/\u003eTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\u003cbr/\u003ein the AWS Billing and Cost Management User Guide, and Controlling Access\u003cbr/\u003eUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\u003cbr/\u003e_ . : / = + - @.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are key-value pairs that can be associated with Step Functions state\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emachines and activities.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\nTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\nin the AWS Billing and Cost Management User Guide, and Controlling Access\nUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/p\u003e\n\u003cp\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\n_ . : / = + - @. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the activity is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:49,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/addon/",title:"Addon",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Addon"\u003eeks-controller/apis/v1alpha1#Addon\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAddon\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAddonList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaddons\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eaddon\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Amazon EKS add-on. For more information, see Amazon EKS add-ons (https://docs.aws.amazon.com/eks/latest/userguide/eks-add-ons.html)\nin the Amazon EKS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaddonVersion: string\nclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nconfigurationValues: string\nname: string\nresolveConflicts: string\nserviceAccountRoleARN: string\nserviceAccountRoleRef: \n from: \n name: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaddonVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the add-on. The version must match one of the versions returned\u003cbr/\u003eby DescribeAddonVersions (https://docs.aws.amazon.com/eks/latest/APIReference/API_DescribeAddonVersions.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe set of configuration values for the add-on that\u0026rsquo;s created. The values\u003cbr/\u003ethat you provide are validated against the schema returned by DescribeAddonConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the add-on. The name must match one of the names returned by\u003cbr/\u003eDescribeAddonVersions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolveConflicts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eHow to resolve field value conflicts for an Amazon EKS add-on. Conflicts\u003cbr/\u003eare handled based on the value you choose:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * None – If the self-managed version of the add-on is installed on your\u003cbr/\u003e cluster, Amazon EKS doesn\u0026rsquo;t change the value. Creation of the add-on might\u003cbr/\u003e fail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Overwrite – If the self-managed version of the add-on is installed\u003cbr/\u003e on your cluster and the Amazon EKS default value is different than the\u003cbr/\u003e existing value, Amazon EKS changes the value to the Amazon EKS default\u003cbr/\u003e value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Preserve – This is similar to the NONE option. If the self-managed\u003cbr/\u003e version of the add-on is installed on your cluster Amazon EKS doesn\u0026rsquo;t\u003cbr/\u003e change the add-on resource properties. Creation of the add-on might fail\u003cbr/\u003e if conflicts are detected. This option works differently during the update\u003cbr/\u003e operation. For more information, see UpdateAddon (https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t currently have the self-managed version of the add-on installed\u003cbr/\u003eon your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all\u003cbr/\u003evalues to default values, regardless of the option that you specify.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on\u0026rsquo;s\u003cbr/\u003eservice account. The role must be assigned the IAM permissions required by\u003cbr/\u003ethe add-on. If you don\u0026rsquo;t specify an existing IAM role, then the add-on uses\u003cbr/\u003ethe permissions assigned to the node IAM role. For more information, see\u003cbr/\u003eAmazon EKS node IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo specify an existing IAM role, you must have an IAM OpenID Connect (OIDC)\u003cbr/\u003eprovider created for your cluster. For more information, see Enabling IAM\u003cbr/\u003eroles for service accounts on your cluster (https://docs.aws.amazon.com/eks/latest/userguide/enable-iam-roles-for-service-accounts.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccountRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nmarketplaceInformation: \n productID: string\n productURL: string\nmodifiedAt: string\nowner: string\npublisher: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the health of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn issue related to an add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emarketplaceInformation.productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emarketplaceInformation.productURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp for the last modification to the object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe owner of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublisher\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe publisher of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the add-on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:50,href:"https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/adoptedresource/",title:"AdoptedResource",description:null,content:'\u003cp\u003e\u003ccode\u003eservices.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1#AdoptedResource"\u003eruntime/apis/core/v1alpha1#AdoptedResource\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAdoptedResource\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAdoptedResourceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eadoptedresources\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eadoptedresource\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaws: \n additionalKeys: {}\n arn: string\n nameOrID: string\nkubernetes: \n group: string\n kind: string\n metadata: \n annotations: {}\n generateName: string\n labels: {}\n name: string\n namespace: string\n ownerReferences:\n - apiVersion: string\n blockOwnerDeletion: boolean\n controller: boolean\n kind: string\n name: string\n uid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSIdentifiers provide all unique ways to reference an AWS resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.additionalKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditionalKeys represents any additional arbitrary identifiers used when\u003cbr/\u003edescribing the target resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the AWS Resource Name for the resource. It is a globally\u003cbr/\u003eunique identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaws.nameOrID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNameOrId is a user-supplied string identifier for the resource. It may\u003cbr/\u003eor may not be globally unique, depending on the type of resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eResourceWithMetadata provides the values necessary to create a\u003cbr/\u003eKubernetes resource and override any of its metadata values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.group\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eObjectMeta is metadata that all persisted resources must have, which includes all objects\u003cbr/\u003eusers must create.\u003cbr/\u003eIt is not possible to use \u003ccode\u003emetav1.ObjectMeta\u003c/code\u003e inside spec, as the controller-gen\u003cbr/\u003eautomatically converts this to an arbitrary string-string map.\u003cbr/\u003ehttps://github.com/kubernetes-sigs/controller-tools/issues/385\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eActive discussion about inclusion of this field in the spec is happening in this PR:\u003cbr/\u003ehttps://github.com/kubernetes-sigs/controller-tools/pull/395\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUntil this is allowed, or if it never is, we will produce a subset of the object meta\u003cbr/\u003ethat contains only the fields which the user is allowed to modify in the metadata.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.annotations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAnnotations is an unstructured key value map stored with a resource that may be\u003cbr/\u003eset by external tools to store and retrieve arbitrary metadata. They are not\u003cbr/\u003equeryable and should be preserved when modifying objects.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/annotations\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.generateName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eGenerateName is an optional prefix, used by the server, to generate a unique\u003cbr/\u003ename ONLY IF the Name field has not been provided.\u003cbr/\u003eIf this field is used, the name returned to the client will be different\u003cbr/\u003ethan the name passed. This value will also be combined with a unique suffix.\u003cbr/\u003eThe provided value has the same validation rules as the Name field,\u003cbr/\u003eand may be truncated by the length of the suffix required to make the value\u003cbr/\u003eunique on the server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf this field is specified and the generated name exists, the server will\u003cbr/\u003eNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\u003cbr/\u003eServerTimeout indicating a unique name could not be found in the time allotted, and the client\u003cbr/\u003eshould retry (optionally after the time indicated in the Retry-After header).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eApplied only if Name is not specified.\u003cbr/\u003eMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.labels\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap of string keys and values that can be used to organize and categorize\u003cbr/\u003e(scope and select) objects. May match selectors of replication controllers\u003cbr/\u003eand services.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/labels\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eName must be unique within a namespace. Is required when creating resources, although\u003cbr/\u003esome resources may allow a client to request the generation of an appropriate name\u003cbr/\u003eautomatically. Name is primarily intended for creation idempotence and configuration\u003cbr/\u003edefinition.\u003cbr/\u003eCannot be updated.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/identifiers#names\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNamespace defines the space within each name must be unique. An empty namespace is\u003cbr/\u003eequivalent to the \u0026ldquo;default\u0026rdquo; namespace, but \u0026ldquo;default\u0026rdquo; is the canonical representation.\u003cbr/\u003eNot all objects are required to be scoped to a namespace - the value of this field for\u003cbr/\u003ethose objects will be empty.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMust be a DNS_LABEL.\u003cbr/\u003eCannot be updated.\u003cbr/\u003eMore info: http://kubernetes.io/docs/user-guide/namespaces\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of objects depended by this object. If ALL objects in the list have\u003cbr/\u003ebeen deleted, this object will be garbage collected. If this object is managed by a controller,\u003cbr/\u003ethen an entry in this list will point to this controller, with the controller field set to true.\u003cbr/\u003eThere cannot be more than one managing controller.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOwnerReference contains enough information to let you identify an owning\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eobject. An owning object must be in the same namespace as the dependent, or\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ebe cluster-scoped, so there is no namespace field.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].blockOwnerDeletion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf true, AND if the owner has the \u0026ldquo;foregroundDeletion\u0026rdquo; finalizer, then\u003cbr/\u003ethe owner cannot be deleted from the key-value store until this\u003cbr/\u003ereference is removed.\u003cbr/\u003eSee https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion\u003cbr/\u003efor how the garbage collector interacts with this field and enforces the foreground deletion.\u003cbr/\u003eDefaults to false.\u003cbr/\u003eTo set this field, a user needs \u0026ldquo;delete\u0026rdquo; permission of the owner,\u003cbr/\u003eotherwise 422 (Unprocessable Entity) will be returned.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].controller\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf true, this reference points to the managing controller.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].kind\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKind of the referent.\u003cbr/\u003eMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eName of the referent.\u003cbr/\u003eMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetes.metadata.ownerReferences.[].uid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUID of the referent.\u003cbr/\u003eMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various\u003cbr/\u003eterminal states of the adopted resource CR and its target custom resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:51,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/alertmanagerdefinition/",title:"AlertManagerDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#AlertManagerDefinition"\u003eprometheusservice-controller/apis/v1alpha1#AlertManagerDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlertManagerDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlertManagerDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealertmanagerdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealertmanagerdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfiguration: string\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace in which to create the alert manager definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatusCode: string\nstatusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus code of this definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for failure if any.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:52,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/alias/",title:"Alias",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Alias"\u003ekms-controller/apis/v1alpha1#Alias\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAliasList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealiases\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\ntargetKeyID: string\ntargetKeyRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the alias name. This value must begin with alias/ followed by a\u003cbr/\u003ename, such as alias/ExampleAlias.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe AliasName value must be string of 1-256 characters. It can contain only\u003cbr/\u003ealphanumeric characters, forward slashes (/), underscores (_), and dashes\u003cbr/\u003e(-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is\u003cbr/\u003ereserved for Amazon Web Services managed keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAssociates the alias with the specified customer managed key (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk).\u003cbr/\u003eThe KMS key must be in the same Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA valid key ID is required. If you supply a null or empty string value, this\u003cbr/\u003eoperation returns an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor help finding the key ID and ARN, see Finding the Key ID and ARN (https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the key ID or key ARN of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:53,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/alias/",title:"Alias",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Alias"\u003elambda-controller/apis/v1alpha1#Alias\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAlias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAliasList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealiases\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ealias\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nfunctionVersion: string\nname: string\nprovisionedConcurrencyConfig: \n functionName: string\n provisionedConcurrentExecutions: integer\n qualifier: string\nroutingConfig: \n additionalVersionWeights: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures options for asynchronous invocation on an alias.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- DestinationConfig\u003cbr/\u003eA destination for events after they have been sent to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypes of Destinations:\u003cbr/\u003eFunction - The Amazon Resource Name (ARN) of a Lambda function.\u003cbr/\u003eQueue - The ARN of a standard SQS queue.\u003cbr/\u003eTopic - The ARN of a standard SNS topic.\u003cbr/\u003eEvent Bus - The ARN of an Amazon EventBridge event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumEventAgeInSeconds\u003cbr/\u003eThe maximum age of a request that Lambda sends to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumRetryAttempts\u003cbr/\u003eThe maximum number of times to retry when the function returns an error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name - MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN - 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function version that the alias invokes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures provisioned concurrency to a function\u0026rsquo;s alias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- ProvisionedConcurrentExecutions\u003cbr/\u003eThe amount of provisioned concurrency to allocate for the version or alias.\u003cbr/\u003eMinimum value of 1 is required\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.provisionedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe routing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html#configuring-alias-routing)\u003cbr/\u003eof the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.additionalVersionWeights\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nrevisionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique identifier that changes when you update the alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:54,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/api/",title:"API",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#API"\u003eapigatewayv2-controller/apis/v1alpha1#API\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAPI\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAPIList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapis\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapi\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an API.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiKeySelectionExpression: string\nbasepath: string\nbody: string\ncorsConfiguration: \n allowCredentials: boolean\n allowHeaders:\n - string\n allowMethods:\n - string\n allowOrigins:\n - string\n exposeHeaders:\n - string\n maxAge: integer\ncredentialsARN: string\ndescription: string\ndisableExecuteAPIEndpoint: boolean\ndisableSchemaValidation: boolean\nfailOnWarnings: boolean\nname: string\nprotocolType: string\nrouteKey: string\nrouteSelectionExpression: string\ntags: {}\ntarget: string\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiKeySelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebasepath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebody\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CORS configuration. Supported only for HTTP APIs. See Configuring\u003cbr/\u003eCORS (https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of allowed headers. Supported only for HTTP APIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.allowOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecorsConfiguration.exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableExecuteAPIEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableSchemaValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailOnWarnings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprotocolType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiEndpoint: string\napiGatewayManaged: boolean\napiID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nimportInfo:\n- string\nwarnings:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportInfo.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarnings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:55,href:"https://aws-controllers-k8s.github.io/community/reference/",title:"API Reference",description:null,content:""}).add({id:56,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/app/",title:"App",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#App"\u003esagemaker-controller/apis/v1alpha1#App\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eApp\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAppList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapps\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eapp\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappName: string\nappType: string\ndomainID: string\nresourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\ntags:\n- key: string\n value: string\nuserProfileName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the app.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of app.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe instance type and the Amazon Resource Name (ARN) of the SageMaker image\u003cbr/\u003ecreated on the instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value of InstanceType passed as part of the ResourceSpec in the CreateApp\u003cbr/\u003ecall overrides the value passed as part of the ResourceSpec configured for\u003cbr/\u003ethe user profile or the domain. If InstanceType is not specified in any of\u003cbr/\u003ethose three ResourceSpec values for a KernelGateway app, the CreateApp call\u003cbr/\u003efails with a request validation error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEach tag consists of a key and an optional value. Tag keys must be unique\u003cbr/\u003eper resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserProfileName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe user profile name. If this value is not set, then SpaceName must be set. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:57,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/archive/",title:"Archive",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Archive"\u003eeventbridge-controller/apis/v1alpha1#Archive\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eArchive\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eArchiveList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003earchives\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003earchive\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Archive object that contains details about an archive.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventPattern: string\neventSourceARN: string\neventSourceRef: \n from: \n name: string\nname: string\nretentionDays: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventPattern\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn event pattern to use to filter events sent to the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the event bus that sends events to the archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the archive to create.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain events for. Default value is 0. If set to 0,\u003cbr/\u003eevents are retained indefinitely\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nstate: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the archive was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the archive that was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason that the archive is in the state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:58,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/authorizer/",title:"Authorizer",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Authorizer"\u003eapigatewayv2-controller/apis/v1alpha1#Authorizer\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAuthorizer\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eAuthorizerList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eauthorizers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eauthorizer\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an authorizer.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\nauthorizerCredentialsARN: string\nauthorizerPayloadFormatVersion: string\nauthorizerResultTTLInSeconds: integer\nauthorizerType: string\nauthorizerURI: string\nenableSimpleResponses: boolean\nidentitySource:\n- string\nidentityValidationExpression: string\njwtConfiguration: \n audience:\n - string\n issuer: string\nname: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerCredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerPayloadFormatVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerResultTTLInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableSimpleResponses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentitySource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentitySource.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the configuration of a JWT authorizer. Required for the JWT authorizer\u003cbr/\u003etype. Supported only for HTTP APIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration.audience\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejwtConfiguration.audience.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nauthorizerID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:59,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/backup/",title:"Backup",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#Backup"\u003edynamodb-controller/apis/v1alpha1#Backup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBackup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBackupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebackups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebackup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebackupName: string\ntableName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecified name for the backup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbackupCreationDateTime: string\nbackupExpiryDateTime: string\nbackupSizeBytes: integer\nbackupStatus: string\nbackupType: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupCreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTime at which the backup was created. This is the request time of the backup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupExpiryDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTime at which the automatic on-demand backup created by DynamoDB will expire.\u003cbr/\u003eThis SYSTEM on-demand backup expires automatically 35 days after its creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSize of the backup in bytes. DynamoDB updates this value approximately every\u003cbr/\u003esix hours. Recent changes might not be reflected in this value.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eBackup can be in one of the following states: CREATING, ACTIVE, DELETED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eBackupType:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * USER - You create and manage these using the on-demand backup feature.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SYSTEM - If you delete a table with point-in-time recovery enabled,\u003cbr/\u003e a SYSTEM backup is automatically created and is retained for 35 days (at\u003cbr/\u003e no additional cost). System backups allow you to restore the deleted table\u003cbr/\u003e to the state it was in just before the point of deletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AWS_BACKUP - On-demand backup created by you from Backup service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:60,href:"https://aws-controllers-k8s.github.io/community/reference/mq/v1alpha1/broker/",title:"Broker",description:null,content:'\u003cp\u003e\u003ccode\u003emq.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/mq-controller/apis/v1alpha1#Broker"\u003emq-controller/apis/v1alpha1#Broker\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBroker\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBrokerList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebrokers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebroker\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauthenticationStrategy: string\nautoMinorVersionUpgrade: boolean\nconfiguration: \n id: string\n revision: integer\ncreatorRequestID: string\ndeploymentMode: string\nencryptionOptions: \n kmsKeyID: string\n useAWSOwnedKey: boolean\nengineType: string\nengineVersion: string\nhostInstanceType: string\nldapServerMetadata: \n hosts:\n - string\n roleBase: string\n roleName: string\n roleSearchMatching: string\n roleSearchSubtree: boolean\n serviceAccountPassword: string\n serviceAccountUsername: string\n userBase: string\n userRoleName: string\n userSearchMatching: string\n userSearchSubtree: boolean\nlogs: \n audit: boolean\n general: boolean\nmaintenanceWindowStartTime: \n dayOfWeek: string\n timeOfDay: string\n timeZone: string\nname: string\npubliclyAccessible: boolean\nsecurityGroupRefs:\n from: \n name: string\nsecurityGroups:\n- string\nstorageType: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags: {}\nusers:\n- consoleAccess: boolean\n groups:\n - string\n password: \n key: string\n name: string\n namespace: string\n username: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of information about the configuration.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.revision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEncryption options for the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionOptions.useAWSOwnedKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostInstanceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional. The metadata of the LDAP server used to authenticate and authorize\u003cbr/\u003econnections to the broker.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDoes not apply to RabbitMQ brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.hosts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.hosts.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleSearchMatching\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.roleSearchSubtree\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.serviceAccountPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.serviceAccountUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userBase\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userSearchMatching\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eldapServerMetadata.userSearchSubtree\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of information about logs to be enabled for the specified broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs.audit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogs.general\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe scheduled time period relative to UTC during which Amazon MQ begins to\u003cbr/\u003eapply pending updates or patches to the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.dayOfWeek\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.timeOfDay\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindowStartTime.timeZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA user associated with the broker. For RabbitMQ brokers, one and only one\nadministrative user is accepted and created when a broker is first provisioned.\nAll subsequent broker users are created by making RabbitMQ API calls directly\nto brokers or via the RabbitMQ web console. || \u003cstrong\u003eusers.[].consoleAccess\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[].groups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eusers.[].groups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eusers.[].password\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret |\n| \u003cstrong\u003eusers.[].password.key\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret |\n| \u003cstrong\u003eusers.[].password.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource. |\n| \u003cstrong\u003eusers.[].password.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique. |\n| \u003cstrong\u003eusers.[].username\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbrokerID: string\nbrokerInstances:\n- consoleURL: string\n endpoints:\n - string\n ipAddress: string\nbrokerState: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns information about all brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[].endpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerInstances.[].endpoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:61,href:"https://aws-controllers-k8s.github.io/community/reference/s3/v1alpha1/bucket/",title:"Bucket",description:null,content:'\u003cp\u003e\u003ccode\u003es3.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/s3-controller/apis/v1alpha1#Bucket"\u003es3-controller/apis/v1alpha1#Bucket\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBucket\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eBucketList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebuckets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ebucket\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIn terms of implementation, a Bucket is a resource. An Amazon S3 bucket name\nis globally unique, and the namespace is shared by all Amazon Web Services\naccounts.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccelerate: \n status: string\nacl: string\nanalytics:\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n storageClassAnalysis: \n dataExport: \n destination: \n s3BucketDestination: \n bucket: string\n bucketAccountID: string\n format: string\n prefix: string\n outputSchemaVersion: string\ncors: \n corsRules:\n allowedHeaders:\n - string\n allowedMethods:\n - string\n allowedOrigins:\n - string\n exposeHeaders:\n - string\n id: string\n maxAgeSeconds: integer\ncreateBucketConfiguration: \n locationConstraint: string\nencryption: \n rules:\n applyServerSideEncryptionByDefault: \n kmsMasterKeyID: string\n sseAlgorithm: string\n bucketKeyEnabled: boolean\ngrantFullControl: string\ngrantRead: string\ngrantReadACP: string\ngrantWrite: string\ngrantWriteACP: string\nintelligentTiering:\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n status: string\n tierings:\n - accessTier: string\n days: integer\ninventory:\n destination: \n s3BucketDestination: \n accountID: string\n bucket: string\n encryption: \n sseKMS: \n keyID: string\n format: string\n prefix: string\n filter: \n prefix: string\n id: string\n includedObjectVersions: string\n isEnabled: boolean\n optionalFields:\n - string\n schedule: \n frequency: string\nlifecycle: \n rules:\n abortIncompleteMultipartUpload: \n daysAfterInitiation: integer\n expiration: \n date: string\n days: integer\n expiredObjectDeleteMarker: boolean\n filter: \n and: \n objectSizeGreaterThan: integer\n objectSizeLessThan: integer\n prefix: string\n tags:\n - key: string\n value: string\n objectSizeGreaterThan: integer\n objectSizeLessThan: integer\n prefix: string\n tag: \n key: string\n value: string\n id: string\n noncurrentVersionExpiration: \n newerNoncurrentVersions: integer\n noncurrentDays: integer\n noncurrentVersionTransitions:\n - newerNoncurrentVersions: integer\n noncurrentDays: integer\n storageClass: string\n prefix: string\n status: string\n transitions:\n - date: string\n days: integer\n storageClass: string\nlogging: \n loggingEnabled: \n targetBucket: string\n targetGrants:\n grantee: \n displayName: string\n emailAddress: string\n id: string\n type_: string\n uRI: string\n permission: string\n targetPrefix: string\nmetrics:\n filter: \n accessPointARN: string\n and: \n accessPointARN: string\n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\nname: string\nnotification: \n lambdaFunctionConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n lambdaFunctionARN: string\n queueConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n queueARN: string\n topicConfigurations:\n events:\n - string\n filter: \n key: \n filterRules:\n - name: string\n value: string\n id: string\n topicARN: string\nobjectLockEnabledForBucket: boolean\nobjectOwnership: string\nownershipControls: \n rules:\n - objectOwnership: string\npolicy: string\npublicAccessBlock: \n blockPublicACLs: boolean\n blockPublicPolicy: boolean\n ignorePublicACLs: boolean\n restrictPublicBuckets: boolean\nreplication: \n role: string\n rules:\n deleteMarkerReplication: \n status: string\n destination: \n accessControlTranslation: \n owner: string\n account: string\n bucket: string\n encryptionConfiguration: \n replicaKMSKeyID: string\n metrics: \n eventThreshold: \n minutes: integer\n status: string\n replicationTime: \n status: string\n time: \n minutes: integer\n storageClass: string\n existingObjectReplication: \n status: string\n filter: \n and: \n prefix: string\n tags:\n - key: string\n value: string\n prefix: string\n tag: \n key: string\n value: string\n id: string\n prefix: string\n priority: integer\n sourceSelectionCriteria: \n replicaModifications: \n status: string\n sseKMSEncryptedObjects: \n status: string\n status: string\nrequestPayment: \n payer: string\ntagging: \n tagSet:\n - key: string\n value: string\nversioning: \n status: string\nwebsite: \n errorDocument: \n key: string\n indexDocument: \n suffix: string\n redirectAllRequestsTo: \n hostName: string\n protocol: string\n routingRules:\n condition: \n httpErrorCodeReturnedEquals: string\n keyPrefixEquals: string\n redirect: \n hostName: string\n httpRedirectCode: string\n protocol: string\n replaceKeyPrefixWith: string\n replaceKeyWith: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccelerate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for setting the transfer acceleration state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccelerate.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe canned ACL to apply to the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration and any analyses for the analytics filter of\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ean Amazon S3 bucket.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA conjunction (logical AND) of predicates, which is used in evaluating a\u003cbr/\u003emetrics filter. The operator must have at least two predicates in any combination,\u003cbr/\u003eand an object must match all of the predicates for the filter to apply.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies data related to access patterns to be collected and made available\u003cbr/\u003eto analyze the tradeoffs between different storage classes for an Amazon\u003cbr/\u003eS3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for data related to the storage class analysis for an Amazon S3\u003cbr/\u003ebucket for export.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWhere to publish the analytics results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about where to publish the analytics results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.bucketAccountID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.format\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.destination.s3BucketDestination.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalytics.[].storageClassAnalysis.dataExport.outputSchemaVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the cross-origin access configuration for objects in an Amazon\u003cbr/\u003eS3 bucket. For more information, see Enabling Cross-Origin Resource Sharing\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the Amazon\u003cbr/\u003eS3 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a cross-origin access rule for an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].allowedOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.corsRules.[].maxAgeSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateBucketConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration information for the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateBucketConfiguration.locationConstraint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the default server-side-encryption configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the default server-side encryption configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].applyServerSideEncryptionByDefault.kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].applyServerSideEncryptionByDefault.sseAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryption.rules.[].bucketKeyEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantFullControl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee the read, write, read ACP, and write ACP permissions on the\u003cbr/\u003ebucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantRead\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to list the objects in the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantReadACP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to read the bucket ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantWrite\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to create new objects in the bucket.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the bucket and object owners of existing objects, also allows deletions\u003cbr/\u003eand overwrites of those objects.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantWriteACP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAllows grantee to write the ACL for the applicable bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintelligentTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintelligentTiering.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor information about the S3 Intelligent-Tiering storage class, see Storage\nclass for automatically optimizing frequently and infrequently accessed objects\n(https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). || \u003cstrong\u003eintelligentTiering.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Filter is used to identify objects that the S3 Intelligent-Tiering configuration\u003cbr/\u003eapplies to. |\n| \u003cstrong\u003eintelligentTiering.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container for specifying S3 Intelligent-Tiering filters. The filters determine\u003cbr/\u003ethe subset of objects to which the rule applies. |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. || \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe S3 Intelligent-Tiering storage class is designed to optimize storage\ncosts by automatically moving data to the most cost-effective storage access\ntier, without additional operational overhead. || \u003cstrong\u003eintelligentTiering.[].tierings.[].accessTier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eintelligentTiering.[].tierings.[].days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the inventory configuration for an Amazon S3 bucket. For more information,\nsee GET Bucket inventory (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html)\nin the Amazon S3 API Reference. || \u003cstrong\u003einventory.[].destination\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the inventory configuration for an Amazon S3 bucket. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the bucket name, file format, bucket owner (optional), and prefix\u003cbr/\u003e(optional) where inventory results are published. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.accountID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.bucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the type of server-side encryption used to encrypt the inventory\u003cbr/\u003eresults. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption.sseKMS\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the use of SSE-KMS to encrypt delivered inventory reports. |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.encryption.sseKMS.keyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.format\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].destination.s3BucketDestination.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an inventory filter. The inventory only includes objects that meet\u003cbr/\u003ethe filter\u0026rsquo;s criteria. |\n| \u003cstrong\u003einventory.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].includedObjectVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].isEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].optionalFields\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einventory.[].optionalFields.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003einventory.[].schedule\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the schedule for generating inventory results. |\n| \u003cstrong\u003einventory.[].schedule.frequency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for lifecycle rules. You can add as many as 1,000 rules. |\n| \u003cstrong\u003elifecycle.rules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA lifecycle rule for individual objects in an Amazon S3 bucket. || \u003cstrong\u003elifecycle.rules.[].abortIncompleteMultipartUpload\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the days since the initiation of an incomplete multipart upload\u003cbr/\u003ethat Amazon S3 will wait before permanently removing all parts of the upload.\u003cbr/\u003eFor more information, see Aborting Incomplete Multipart Uploads Using a Bucket\u003cbr/\u003eLifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| \u003cstrong\u003elifecycle.rules.[].abortIncompleteMultipartUpload.daysAfterInitiation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the expiration for the lifecycle of the object. |\n| \u003cstrong\u003elifecycle.rules.[].expiration.date\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration.days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].expiration.expiredObjectDeleteMarker\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Filter is used to identify objects that a Lifecycle Rule applies to.\u003cbr/\u003eA Filter must have exactly one of Prefix, Tag, or And specified. |\n| \u003cstrong\u003elifecycle.rules.[].filter.and\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis is used in a Lifecycle Rule Filter to apply a logical AND to two or\u003cbr/\u003emore predicates. The Lifecycle Rule will apply to any object matching all\u003cbr/\u003eof the predicates configured inside the And operator. |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.objectSizeGreaterThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.objectSizeLessThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. || \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.and.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.objectSizeGreaterThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.objectSizeLessThan\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA container of a key value name pair. |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag.key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].filter.tag.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies when noncurrent object versions expire. Upon expiration, Amazon\u003cbr/\u003eS3 permanently deletes the noncurrent object versions. You set this lifecycle\u003cbr/\u003econfiguration action on a bucket that has versioning enabled (or suspended)\u003cbr/\u003eto request that Amazon S3 delete noncurrent object versions at a specific\u003cbr/\u003eperiod in the object\u0026rsquo;s lifetime. |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration.newerNoncurrentVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionExpiration.noncurrentDays\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the transition rule that describes when noncurrent objects\ntransition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR,\nGLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled\n(or versioning is suspended), you can set this action to request that Amazon\nS3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA,\nINTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at\na specific period in the object\u0026rsquo;s lifetime. || \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].newerNoncurrentVersions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].noncurrentDays\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].noncurrentVersionTransitions.[].storageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies when an object transitions to a specified storage class. For more\ninformation about Amazon S3 lifecycle configuration rules, see Transitioning\nObjects Using Amazon S3 Lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html)\nin the Amazon S3 User Guide. || \u003cstrong\u003elifecycle.rules.[].transitions.[].date\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[].days\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecycle.rules.[].transitions.[].storageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for logging status information. |\n| \u003cstrong\u003elogging.loggingEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes where logs are stored and the prefix that Amazon S3 assigns to\u003cbr/\u003eall log object keys for a bucket. For more information, see PUT Bucket logging\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html)\u003cbr/\u003ein the Amazon S3 API Reference. |\n| \u003cstrong\u003elogging.loggingEnabled.targetBucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for granting information.\u003c/p\u003e\n\u003cp\u003eBuckets that use the bucket owner enforced setting for Object Ownership don\u0026rsquo;t\nsupport target grants. For more information, see Permissions server access\nlog delivery (https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html#grant-log-delivery-permissions-general)\nin the Amazon S3 User Guide. || \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer for the person being granted permissions. |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.displayName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.emailAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elogging.loggingEnabled.targetGrants.[].grantee.id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].grantee.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].grantee.uRI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetGrants.[].permission**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **logging.loggingEnabled.targetPrefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **metrics.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies a metrics configuration for the CloudWatch request metrics (specified\nby the metrics configuration ID) from an Amazon S3 bucket. If you\u0026rsquo;re updating\nan existing metrics configuration, note that this is a full replacement of\nthe existing metrics configuration. If you don\u0026rsquo;t include the elements you\nwant to keep, they are erased. For more information, see PutBucketMetricsConfiguration\n(https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). || **metrics.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a metrics configuration filter. The metrics configuration only\u003cbr/\u003eincludes objects that meet the filter\u0026rsquo;s criteria. A filter must be a prefix,\u003cbr/\u003ean object tag, an access point ARN, or a conjunction (MetricsAndOperator).\u003cbr/\u003eFor more information, see PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html). |\n| **metrics.[].filter.accessPointARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA conjunction (logical AND) of predicates, which is used in evaluating a\u003cbr/\u003emetrics filter. The operator must have at least two predicates, and an object\u003cbr/\u003emust match all of the predicates in order for the filter to apply. |\n| **metrics.[].filter.and.accessPointARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **metrics.[].filter.and.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.and.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.tag**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container of a key value name pair. |\n| **metrics.[].filter.tag.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].filter.tag.value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **metrics.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **name**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe name of the bucket to create. |\n| **notification**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for specifying the notification configuration of the bucket.\u003cbr/\u003eIf this element is empty, notifications are turned off for the bucket. |\n| **notification.lambdaFunctionConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container for specifying the configuration for Lambda notifications. || **notification.lambdaFunctionConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.lambdaFunctionConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.lambdaFunctionConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.lambdaFunctionConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.lambdaFunctionConfigurations.[].lambdaFunctionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.queueConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the configuration for publishing messages to an Amazon Simple Queue\nService (Amazon SQS) queue when Amazon S3 detects specified events. || **notification.queueConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.queueConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.queueConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.queueConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.queueConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.queueConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.queueConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.queueConfigurations.[].queueARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.topicConfigurations.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container for specifying the configuration for publication of messages\nto an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3\ndetects specified events. || **notification.topicConfigurations.[].events**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].events.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **notification.topicConfigurations.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies object key name filtering rules. For information about key name\u003cbr/\u003efiltering, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **notification.topicConfigurations.[].filter.key**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for object key name prefix and suffix filtering rules. |\n| **notification.topicConfigurations.[].filter.key.filterRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of containers for the key-value pair that defines the criteria for\u003cbr/\u003ethe filter rule. |\n| **notification.topicConfigurations.[].filter.key.filterRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the Amazon S3 object key name to filter on and whether to filter\non the suffix or prefix of the key name. || **notification.topicConfigurations.[].filter.key.filterRules.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].filter.key.filterRules.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **notification.topicConfigurations.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eAn optional unique identifier for configurations in a notification configuration.\u003cbr/\u003eIf you don\u0026rsquo;t provide one, Amazon S3 will assign an ID. |\n| **notification.topicConfigurations.[].topicARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **objectLockEnabledForBucket**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003eSpecifies whether you want S3 Object Lock to be enabled for the new bucket. |\n| **objectOwnership**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **ownershipControls**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter)\u003cbr/\u003ethat you want to apply to this Amazon S3 bucket. |\n| **ownershipControls.rules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **ownershipControls.rules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe container element for an ownership control rule. || **ownershipControls.rules.[].objectOwnership**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe container element for object ownership for a bucket\u0026rsquo;s ownership controls.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBucketOwnerPreferred - Objects uploaded to the bucket change ownership to\u003cbr/\u003ethe bucket owner if the objects are uploaded with the bucket-owner-full-control\u003cbr/\u003ecanned ACL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eObjectWriter - The uploading account will own the object if the object is\u003cbr/\u003euploaded with the bucket-owner-full-control canned ACL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer\u003cbr/\u003eaffect permissions. The bucket owner automatically owns and has full control\u003cbr/\u003eover every object in the bucket. The bucket only accepts PUT requests that\u003cbr/\u003edon\u0026rsquo;t specify an ACL or bucket owner full control ACLs, such as the bucket-owner-full-control\u003cbr/\u003ecanned ACL or an equivalent form of this ACL expressed in the XML format. |\n| **policy**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe bucket policy as a JSON document. |\n| **publicAccessBlock**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe PublicAccessBlock configuration that you want to apply to this Amazon\u003cbr/\u003eS3 bucket. You can enable the configuration options in any combination. For\u003cbr/\u003emore information about when Amazon S3 considers a bucket or object public,\u003cbr/\u003esee The Meaning of \u0026ldquo;Public\u0026rdquo; (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **publicAccessBlock.blockPublicACLs**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.blockPublicPolicy**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.ignorePublicACLs**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **publicAccessBlock.restrictPublicBuckets**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **replication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for replication rules. You can add up to 1,000 rules. The maximum\u003cbr/\u003esize of a replication configuration is 2 MB. |\n| **replication.role**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **replication.rules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies which Amazon S3 objects to replicate and where to store the replicas. || **replication.rules.[].deleteMarkerReplication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies whether Amazon S3 replicates delete markers. If you specify a Filter\u003cbr/\u003ein your replication configuration, you must also include a DeleteMarkerReplication\u003cbr/\u003eelement. If your Filter includes a Tag element, the DeleteMarkerReplication\u003cbr/\u003eStatus must be set to Disabled, because Amazon S3 does not support replicating\u003cbr/\u003edelete markers for tag-based rules. For an example configuration, see Basic\u003cbr/\u003eRule Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about delete marker replication, see Basic Rule Configuration\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an earlier version of the replication configuration, Amazon\u003cbr/\u003eS3 handles replication of delete markers differently. For more information,\u003cbr/\u003esee Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). |\n| **replication.rules.[].deleteMarkerReplication.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies information about where to publish analysis or configuration results\u003cbr/\u003efor an Amazon S3 bucket and S3 Replication Time Control (S3 RTC). |\n| **replication.rules.[].destination.accessControlTranslation**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for information about access control for replicas. |\n| **replication.rules.[].destination.accessControlTranslation.owner**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.account**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.bucket**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.encryptionConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies encryption-related information for an Amazon S3 bucket that is\u003cbr/\u003ea destination for replicated objects. |\n| **replication.rules.[].destination.encryptionConfiguration.replicaKMSKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.metrics**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying replication metrics-related settings enabling replication\u003cbr/\u003emetrics and events. |\n| **replication.rules.[].destination.metrics.eventThreshold**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying the time value for S3 Replication Time Control (S3\u003cbr/\u003eRTC) and replication metrics EventThreshold. |\n| **replication.rules.[].destination.metrics.eventThreshold.minutes**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].destination.metrics.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.replicationTime**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying S3 Replication Time Control (S3 RTC) related information,\u003cbr/\u003eincluding whether S3 RTC is enabled and the time when all objects and operations\u003cbr/\u003eon objects must be replicated. Must be specified together with a Metrics\u003cbr/\u003eblock. |\n| **replication.rules.[].destination.replicationTime.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].destination.replicationTime.time**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container specifying the time value for S3 Replication Time Control (S3\u003cbr/\u003eRTC) and replication metrics EventThreshold. |\n| **replication.rules.[].destination.replicationTime.time.minutes**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].destination.storageClass**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].existingObjectReplication**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eOptional configuration to replicate existing source bucket objects. For more\u003cbr/\u003einformation, see Replicating Existing Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-what-is-isnot-replicated.html#existing-object-replication)\u003cbr/\u003ein the Amazon S3 User Guide. |\n| **replication.rules.[].existingObjectReplication.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA filter that identifies the subset of objects to which the replication rule\u003cbr/\u003eapplies. A Filter must specify exactly one Prefix, Tag, or an And child element. |\n| **replication.rules.[].filter.and**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for specifying rule filters. The filters determine the subset\u003cbr/\u003eof objects to which the rule applies. This element is required only if you\u003cbr/\u003especify more than one filter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you specify both a Prefix and a Tag filter, wrap these filters in\u003cbr/\u003e an And tag.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you specify a filter based on multiple tags, wrap the Tag elements\u003cbr/\u003e in an And tag. |\n| **replication.rules.[].filter.and.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **replication.rules.[].filter.and.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.and.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.tag**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container of a key value name pair. |\n| **replication.rules.[].filter.tag.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].filter.tag.value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].prefix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].priority**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **replication.rules.[].sourceSelectionCriteria**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container that describes additional filters for identifying the source\u003cbr/\u003eobjects that you want to replicate. You can choose to enable or disable the\u003cbr/\u003ereplication of these objects. Currently, Amazon S3 supports only the filter\u003cbr/\u003ethat you can specify for objects created with server-side encryption using\u003cbr/\u003ea customer managed key stored in Amazon Web Services Key Management Service\u003cbr/\u003e(SSE-KMS). |\n| **replication.rules.[].sourceSelectionCriteria.replicaModifications**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA filter that you can specify for selection for modifications on replicas.\u003cbr/\u003eAmazon S3 doesn\u0026rsquo;t replicate replica modifications by default. In the latest\u003cbr/\u003eversion of replication configuration (when Filter is specified), you can\u003cbr/\u003especify this element and set the status to Enabled to replicate modifications\u003cbr/\u003eon replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify the Filter element, Amazon S3 assumes that the replication\u003cbr/\u003econfiguration is the earlier version, V1. In the earlier version, this element\u003cbr/\u003eis not allowed. |\n| **replication.rules.[].sourceSelectionCriteria.replicaModifications.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].sourceSelectionCriteria.sseKMSEncryptedObjects**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for filter information for the selection of S3 objects encrypted\u003cbr/\u003ewith Amazon Web Services KMS. |\n| **replication.rules.[].sourceSelectionCriteria.sseKMSEncryptedObjects.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **replication.rules.[].status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **requestPayment**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for Payer. |\n| **requestPayment.payer**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tagging**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the TagSet and Tag elements. |\n| **tagging.tagSet**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **tagging.tagSet.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA container of a key value name pair. || **tagging.tagSet.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tagging.tagSet.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **versioning**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for setting the versioning state. |\n| **versioning.status**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the request. |\n| **website.errorDocument**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe error information. |\n| **website.errorDocument.key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.indexDocument**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContainer for the Suffix element. |\n| **website.indexDocument.suffix**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.redirectAllRequestsTo**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies the redirect behavior of all requests to a website endpoint of\u003cbr/\u003ean Amazon S3 bucket. |\n| **website.redirectAllRequestsTo.hostName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.redirectAllRequestsTo.protocol**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **website.routingRules.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies the redirect behavior and when a redirect is applied. For more\ninformation about routing rules, see Configuring advanced conditional redirects\n(https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html#advanced-conditional-redirects)\nin the Amazon S3 User Guide. || **website.routingRules.[].condition**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA container for describing a condition that must be met for the specified\u003cbr/\u003eredirect to apply. For example, 1. If request is for pages in the /docs folder,\u003cbr/\u003eredirect to the /documents folder. 2. If request results in HTTP error 4xx,\u003cbr/\u003eredirect request to another host where you might process the error. |\n| **website.routingRules.[].condition.httpErrorCodeReturnedEquals**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].condition.keyPrefixEquals**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies how requests are redirected. In the event of an error, you can\u003cbr/\u003especify a different error code to return. |\n| **website.routingRules.[].redirect.hostName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.httpRedirectCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.protocol**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.replaceKeyPrefixWith**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **website.routingRules.[].redirect.replaceKeyWith**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA forward slash followed by the name of the bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:62,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/cacheparametergroup/",title:"CacheParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#CacheParameterGroup"\u003eelasticache-controller/apis/v1alpha1#CacheParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecacheparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecacheparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of a CreateCacheParameterGroup operation.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheParameterGroupFamily: string\ncacheParameterGroupName: string\ndescription: string\nparameterNameValues:\n- parameterName: string\n parameterValue: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupFamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache parameter group family that the cache parameter group can be used with. \u003cbr/\u003e Valid values are: memcached1.4\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-specified name for the cache parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-specified description for the cache parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a name-value pair that is used to update the value of a parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nisGlobal: boolean\nparameters:\n- allowedValues: string\n changeType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisGlobal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the parameter group is associated with a Global datastore\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Parameter instances.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an individual setting that controls some aspect of ElastiCache behavior.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].changeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].source\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:63,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/cachepolicy/",title:"CachePolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#CachePolicy"\u003ecloudfront-controller/apis/v1alpha1#CachePolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCachePolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCachePolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachepolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachepolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA cache policy.\u003c/p\u003e\n\u003cp\u003eWhen it\u0026rsquo;s attached to a cache behavior, the cache policy determines the following:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe values that CloudFront includes in the cache key. These values can\ninclude HTTP headers, cookies, and URL query strings. CloudFront uses\nthe cache key to find an object in its cache that it can return to the\nviewer.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe default, minimum, and maximum time to live (TTL) values that you\nwant objects to stay in the CloudFront cache.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe headers, cookies, and query strings that are included in the cache key\nare also included in requests that CloudFront sends to the origin. CloudFront\nsends a request when it can\u0026rsquo;t find a valid object in its cache that matches\nthe request\u0026rsquo;s cache key. If you want to send values to the origin but not\ninclude them in the cache key, use OriginRequestPolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecachePolicyConfig: \n comment: string\n defaultTTL: integer\n maxTTL: integer\n minTTL: integer\n name: string\n parametersInCacheKeyAndForwardedToOrigin: \n cookiesConfig: \n cookieBehavior: string\n cookies: \n items:\n - string\n enableAcceptEncodingBrotli: boolean\n enableAcceptEncodingGzip: boolean\n headersConfig: \n headerBehavior: string\n headers: \n items:\n - string\n queryStringsConfig: \n queryStringBehavior: string\n queryStrings: \n items:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA cache policy configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.minTTL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis object determines the values that CloudFront includes in the cache key.\u003cbr/\u003eThese values can include HTTP headers, cookies, and URL query strings. CloudFront\u003cbr/\u003euses the cache key to find an object in its cache that it can return to the\u003cbr/\u003eviewer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe headers, cookies, and query strings that are included in the cache key\u003cbr/\u003eare also included in requests that CloudFront sends to the origin. CloudFront\u003cbr/\u003esends a request when it can\u0026rsquo;t find an object in its cache that matches the\u003cbr/\u003erequest\u0026rsquo;s cache key. If you want to send values to the origin but not include\u003cbr/\u003ethem in the cache key, use OriginRequestPolicy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any cookies in viewer requests (and if\u003cbr/\u003eso, which cookies) are included in the cache key and in requests that CloudFront\u003cbr/\u003esends to the origin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookieBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.cookiesConfig.cookies.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.enableAcceptEncodingGzip\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any HTTP headers (and if so, which headers)\u003cbr/\u003eare included in the cache key and in requests that CloudFront sends to the\u003cbr/\u003eorigin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headerBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.headersConfig.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStringBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of query string names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecachePolicyConfig.parametersInCacheKeyAndForwardedToOrigin.queryStringsConfig.queryStrings.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current version of the cache policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the cache policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the cache policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:64,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/cachesubnetgroup/",title:"CacheSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#CacheSubnetGroup"\u003eelasticache-controller/apis/v1alpha1#CacheSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCacheSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachesubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecachesubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of one of the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreateCacheSubnetGroup\u003c/li\u003e\n\u003cli\u003eModifyCacheSubnetGroup\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheSubnetGroupDescription: string\ncacheSubnetGroupName: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the cache subnet group. This value is stored as a lowercase string. \u003cbr/\u003e Constraints: Must contain no more than 255 alphanumeric characters or hyphens. \u003cbr/\u003e Example: mysubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of VPC subnet IDs for the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n subnetOutpostARN: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of subnets associated with the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID of the outpost subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost.subnetOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:65,href:"https://aws-controllers-k8s.github.io/community/reference/acm/v1alpha1/certificate/",title:"Certificate",description:null,content:'\u003cp\u003e\u003ccode\u003eacm.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acm-controller/apis/v1alpha1#Certificate"\u003eacm-controller/apis/v1alpha1#Certificate\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificates\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificateAuthorityARN: string\ndomainName: string\ndomainValidationOptions:\n- domainName: string\n validationDomain: string\nkeyAlgorithm: string\noptions: \n certificateTransparencyLoggingPreference: string\nsubjectAlternativeNames:\n- string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the private certificate authority (CA)\u003cbr/\u003ethat will be used to issue the certificate. If you do not provide an ARN\u003cbr/\u003eand you are trying to request a private certificate, ACM will attempt to\u003cbr/\u003eissue a public certificate. For more information about private CAs, see the\u003cbr/\u003eAmazon Web Services Private Certificate Authority (https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html)\u003cbr/\u003euser guide. The ARN must have the following form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFully qualified domain name (FQDN), such as www.example.com, that you want\u003cbr/\u003eto secure with an ACM certificate. Use an asterisk (\u003cem\u003e) to create a wildcard\u003cbr/\u003ecertificate that protects several sites in the same domain. For example,\u003cbr/\u003e\u003c/em\u003e.example.com protects www.example.com, site.example.com, and images.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIn compliance with RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280),\u003cbr/\u003ethe length of the domain name (technically, the Common Name) that you provide\u003cbr/\u003ecannot exceed 64 octets (characters), including periods. To add a longer\u003cbr/\u003edomain name, specify it in the Subject Alternative Name field, which supports\u003cbr/\u003enames up to 253 octets in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe domain name that you want ACM to use to send you emails so that you can\u003cbr/\u003evalidate domain ownership.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the domain names that you want ACM to use to send\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou emails that enable you to validate domain ownership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidationOptions.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the algorithm of the public and private key pair that your certificate\u003cbr/\u003euses to encrypt data. RSA is the default key algorithm for ACM certificates.\u003cbr/\u003eElliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering\u003cbr/\u003esecurity comparable to RSA keys but with greater computing efficiency. However,\u003cbr/\u003eECDSA is not supported by all network clients. Some AWS services may require\u003cbr/\u003eRSA keys, or only support ECDSA keys of a particular size, while others allow\u003cbr/\u003ethe use of either RSA and ECDSA keys to ensure that compatibility is not\u003cbr/\u003ebroken. Check the requirements for the AWS service where you plan to deploy\u003cbr/\u003eyour certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: RSA_2048\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCurrently, you can use this parameter to specify whether to add the certificate\u003cbr/\u003eto a certificate transparency log. Certificate transparency makes it possible\u003cbr/\u003eto detect SSL/TLS certificates that have been mistakenly or maliciously issued.\u003cbr/\u003eCertificates that have not been logged typically produce an error message\u003cbr/\u003ein a browser. For more information, see Opting Out of Certificate Transparency\u003cbr/\u003eLogging (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.certificateTransparencyLoggingPreference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubjectAlternativeNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAdditional FQDNs to be included in the Subject Alternative Name extension\u003cbr/\u003eof the ACM certificate. For example, add the name www.example.net to a certificate\u003cbr/\u003efor which the DomainName field is www.example.com if users can reach your\u003cbr/\u003esite by using either name. The maximum number of domain names that you can\u003cbr/\u003eadd to an ACM certificate is 100. However, the initial quota is 10 domain\u003cbr/\u003enames. If you need more than 10 names, you must request a quota increase.\u003cbr/\u003eFor more information, see Quotas (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum length of a SAN DNS name is 253 octets. The name is made up of\u003cbr/\u003emultiple labels separated by periods. No label can be longer than 63 octets.\u003cbr/\u003eConsider the following examples:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (63 octets).(63 octets).(63 octets).(61 octets) is legal because the\u003cbr/\u003e total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63\u003cbr/\u003e octets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (64 octets).(63 octets).(63 octets).(61 octets) is not legal because\u003cbr/\u003e the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first\u003cbr/\u003e label exceeds 63 octets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * (63 octets).(63 octets).(63 octets).(62 octets) is not legal because\u003cbr/\u003e the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubjectAlternativeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair that identifies or specifies metadata about an ACM resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\ndomainValidations:\n- domainName: string\n resourceRecord: \n name: string\n type_: string\n value: string\n validationDomain: string\n validationEmails:\n - string\n validationMethod: string\n validationStatus: string\nextendedKeyUsages:\n- name: string\n oid: string\nfailureReason: string\nimportedAt: string\ninUseBy:\n- string\nissuedAt: string\nissuer: string\nkeyUsages:\n- name: string\nnotAfter: string\nnotBefore: string\nrenewalEligibility: string\nrenewalSummary: \n domainValidationOptions:\n - domainName: string\n resourceRecord: \n name: string\n type_: string\n value: string\n validationDomain: string\n validationEmails:\n - string\n validationMethod: string\n validationStatus: string\n renewalStatus: string\n renewalStatusReason: string\n updatedAt: string\nrevocationReason: string\nrevokedAt: string\nserial: string\nsignatureAlgorithm: string\nstatus: string\nsubject: string\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the certificate was requested.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains information about the initial validation of each domain name that\u003cbr/\u003eoccurs as a result of the RequestCertificate request. This field exists only\u003cbr/\u003ewhen the certificate type is AMAZON_ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the validation of each domain name in the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a DNS record value that you can use to validate ownership or control\u003cbr/\u003eof a domain. This is used by the DescribeCertificate action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**domainValidations.[].resourceRecord.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].resourceRecord.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationEmails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationEmails.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainValidations.[].validationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of Extended Key Usage X.509 v3 extension objects. Each object\u003cbr/\u003especifies a purpose for which the certificate public key can be used and\u003cbr/\u003econsists of a name and an object identifier (OID).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Extended Key Usage X.509 v3 extension defines one or more purposes for\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewhich the public key can be used. This is in addition to or in place of the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ebasic purposes specified by the Key Usage extension.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eextendedKeyUsages.[].oid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the certificate request failed. This value exists only when the\u003cbr/\u003ecertificate status is FAILED. For more information, see Certificate Request\u003cbr/\u003eFailed (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed)\u003cbr/\u003ein the Certificate Manager User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimportedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the certificate was imported. This value exists only\u003cbr/\u003ewhen the certificate type is IMPORTED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einUseBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of ARNs for the Amazon Web Services resources that are using the certificate.\u003cbr/\u003eA certificate can be used by multiple Amazon Web Services resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einUseBy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eissuer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the certificate authority that issued and signed the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Key Usage X.509 v3 extension objects. Each object is a string value\u003cbr/\u003ethat identifies the purpose of the public key contained in the certificate.\u003cbr/\u003ePossible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION,\u003cbr/\u003eand more.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Key Usage X.509 v3 extension defines the purpose of the public key contained\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the certificate.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotAfter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time after which the certificate is not valid.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotBefore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time before which the certificate is not valid.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalEligibility\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the certificate is eligible for renewal. At this time,\u003cbr/\u003eonly exported private certificates can be renewed with the RenewCertificate\u003cbr/\u003ecommand.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the status of ACM\u0026rsquo;s managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)\u003cbr/\u003efor the certificate. This field exists only when the certificate type is\u003cbr/\u003eAMAZON_ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the validation of each domain name in the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a DNS record value that you can use to validate ownership or control\u003cbr/\u003eof a domain. This is used by the DescribeCertificate action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**renewalSummary.domainValidationOptions.[].resourceRecord.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].resourceRecord.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationEmails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationEmails.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.domainValidationOptions.[].validationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.renewalStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.renewalStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erenewalSummary.updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the certificate was revoked. This value exists only when the certificate\u003cbr/\u003estatus is REVOKED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevokedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the certificate was revoked. This value exists only when\u003cbr/\u003ethe certificate status is REVOKED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserial\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe serial number of the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esignatureAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe algorithm that was used to sign the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA certificate enters status PENDING_VALIDATION upon being requested, unless\u003cbr/\u003eit fails for any of the reasons given in the troubleshooting topic Certificate\u003cbr/\u003erequest fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html).\u003cbr/\u003eACM makes repeated attempts to validate a certificate for 72 hours and then\u003cbr/\u003etimes out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT,\u003cbr/\u003edelete the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html)\u003cbr/\u003eor Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html),\u003cbr/\u003eand try again. If validation succeeds, the certificate enters status ISSUED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubject\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the entity that is associated with the public key contained in\u003cbr/\u003ethe certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe source of the certificate. For certificates provided by ACM, this value\u003cbr/\u003eis AMAZON_ISSUED. For certificates that you imported with ImportCertificate,\u003cbr/\u003ethis value is IMPORTED. ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)\u003cbr/\u003efor imported certificates. For more information about the differences between\u003cbr/\u003ecertificates that you import and those that ACM provides, see Importing Certificates\u003cbr/\u003e(https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)\u003cbr/\u003ein the Certificate Manager User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:66,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificate/",title:"Certificate",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#Certificate"\u003eacmpca-controller/apis/v1alpha1#Certificate\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificates\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificate\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiPassthrough: \n extensions: \n certificatePolicies:\n - certPolicyID: string\n policyQualifiers:\n - policyQualifierID: string\n qualifier: \n cpsURI: string\n customExtensions:\n - critical: boolean\n objectIdentifier: string\n value: string\n extendedKeyUsage:\n - extendedKeyUsageObjectIdentifier: string\n extendedKeyUsageType: string\n keyUsage: \n crlSign: boolean\n dataEncipherment: boolean\n decipherOnly: boolean\n digitalSignature: boolean\n encipherOnly: boolean\n keyAgreement: boolean\n keyCertSign: boolean\n keyEncipherment: boolean\n nonRepudiation: boolean\n subjectAlternativeNames:\n directoryName: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\n dnsName: string\n ediPartyName: \n nameAssigner: string\n partyName: string\n ipAddress: string\n otherName: \n typeID: string\n value: string\n registeredID: string\n rfc822Name: string\n uniformResourceIdentifier: string\n subject: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\ncertificateAuthorityARN: string\ncertificateAuthorityRef: \n from: \n name: string\ncsr: string\ncsrRef: \n from: \n name: string\nsigningAlgorithm: string\ntemplateARN: string\nvalidity: \n type_: string\n value: integer\nvalidityNotBefore: \n type_: string\n value: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies X.509 certificate information to be included in the issued certificate.\u003cbr/\u003eAn APIPassthrough or APICSRPassthrough template variant must be selected,\u003cbr/\u003eor else this parameter is ignored. For more information about using these\u003cbr/\u003etemplates, see Understanding Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf conflicting or duplicate certificate information is supplied during certificate\u003cbr/\u003eissuance, Amazon Web Services Private CA applies order of operation rules\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations)\u003cbr/\u003eto determine what information is used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains X.509 extension information for a certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.509 CertificatePolicies extension.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eModifies the CertPolicyId of a PolicyInformation object with a qualifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAmazon Web Services Private CA supports the certification practice statement\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(CPS) qualifier.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[].qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a PolicyInformation qualifier. Amazon Web Services Private CA supports\u003cbr/\u003ethe certification practice statement (CPS) qualifier (https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4)\u003cbr/\u003edefined in RFC 5280.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.certificatePolicies.[].policyQualifiers.[].qualifier.cpsURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.customExtensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiPassthrough.extensions.customExtensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the X.509 extension information for a certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eExtensions present in CustomExtensions follow the ApiPassthrough template\nrules (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). || \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].critical\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.customExtensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional purposes for which the certified public key may be used\nother than basic purposes indicated in the KeyUsage extension. || \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[].extendedKeyUsageObjectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.extendedKeyUsage.[].extendedKeyUsageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines one or more purposes for which the key contained in the certificate\u003cbr/\u003ecan be used. Default value for each option is false. |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.crlSign\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.dataEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.decipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.digitalSignature\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.encipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyAgreement\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyCertSign\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.keyEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.keyUsage.nonRepudiation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an ASN.1 X.400 GeneralName as defined in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280).\nOnly one of the following naming options should be provided. Providing more\nthan one option results in an InvalidArgsException error. || \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate. |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.commonName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.country\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN). || \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.givenName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.initials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.locality\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.organization\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.state\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.surname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].directoryName.title\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Electronic Data Interchange (EDI) entity as described in as\u003cbr/\u003edefined in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280)\u003cbr/\u003ein RFC 5280. |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName.nameAssigner\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ediPartyName.partyName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a custom ASN.1 X.400 GeneralName using an object identifier (OID)\u003cbr/\u003eand value. The OID must satisfy the regular expression shown below. For more\u003cbr/\u003einformation, see NIST\u0026rsquo;s definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier). |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName.typeID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].otherName.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].registeredID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].rfc822Name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.extensions.subjectAlternativeNames.[].uniformResourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate. |\n| \u003cstrong\u003eapiPassthrough.subject.commonName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.country\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN). || \u003cstrong\u003eapiPassthrough.subject.customAttributes.[].objectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.givenName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.initials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.locality\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.organization\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.state\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.surname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eapiPassthrough.subject.title\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html).\u003cbr/\u003eThis must be of the form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 |\n| \u003cstrong\u003ecertificateAuthorityRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003ecertificateAuthorityRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003ecertificateAuthorityRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecsr\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe certificate signing request (CSR) for the certificate you want to issue.\u003cbr/\u003eAs an example, you can use the following OpenSSL command to create the CSR\u003cbr/\u003eand a 2048 bit RSA private key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem\u003cbr/\u003e-out csr/test_cert_.csr\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you have a configuration file, you can then use the following OpenSSL\u003cbr/\u003ecommand. The usr_cert block in the configuration file contains your X509\u003cbr/\u003eversion 3 extensions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048\u003cbr/\u003e-days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: A CSR must provide either a subject name or a subject alternative name\u003cbr/\u003eor the request will be rejected. |\n| **csrRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **csrRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **csrRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **signingAlgorithm**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe name of the algorithm that will be used to sign the certificate to be\u003cbr/\u003eissued.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter should not be confused with the SigningAlgorithm parameter\u003cbr/\u003eused to sign a CSR in the CreateCertificateAuthority action.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe specified signing algorithm family (RSA or ECDSA) must match the algorithm\u003cbr/\u003efamily of the CA\u0026rsquo;s secret key. |\n| **templateARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eSpecifies a custom configuration template to use when issuing a certificate.\u003cbr/\u003eIf this parameter is not provided, Amazon Web Services Private CA defaults\u003cbr/\u003eto the EndEntityCertificate/V1 template. For CA certificates, you should\u003cbr/\u003echoose the shortest path length that meets your needs. The path length is\u003cbr/\u003eindicated by the PathLenN portion of the ARN, where N is the CA depth (https://docs.aws.amazon.com/privateca/latest/userguide/PcaTerms.html#terms-cadepth).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: The CA depth configured on a subordinate CA certificate must not exceed\u003cbr/\u003ethe limit set by its parents in the CA hierarchy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of TemplateArn values supported by Amazon Web Services Private\u003cbr/\u003eCA, see Understanding Certificate Templates (https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html). |\n| **validity**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation describing the end of the validity period of the certificate.\u003cbr/\u003eThis parameter sets the “Not After” date for the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertificate validity is the period of time during which a certificate is\u003cbr/\u003evalid. Validity can be expressed as an explicit date and time when the certificate\u003cbr/\u003eexpires, or as a span of time after issuance, stated in days, months, or\u003cbr/\u003eyears. For more information, see Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5)\u003cbr/\u003ein RFC 5280.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is unaffected when ValidityNotBefore is also specified. For example,\u003cbr/\u003eif Validity is set to 20 days in the future, the certificate will expire\u003cbr/\u003e20 days from issuance time regardless of the ValidityNotBefore value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe end of the validity period configured on a certificate must not exceed\u003cbr/\u003ethe limit set on its parents in the CA hierarchy. |\n| **validity.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **validity.value**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **validityNotBefore**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eInformation describing the start of the validity period of the certificate.\u003cbr/\u003eThis parameter sets the “Not Before\u0026quot; date for the certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, when issuing a certificate, Amazon Web Services Private CA sets\u003cbr/\u003ethe \u0026ldquo;Not Before\u0026rdquo; date to the issuance time minus 60 minutes. This compensates\u003cbr/\u003efor clock inconsistencies across computer systems. The ValidityNotBefore\u003cbr/\u003eparameter can be used to customize the “Not Before” value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnlike the Validity parameter, the ValidityNotBefore parameter is optional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe ValidityNotBefore value is expressed as an explicit date and time, using\u003cbr/\u003ethe Validity type value ABSOLUTE. For more information, see Validity (https://docs.aws.amazon.com/privateca/latest/APIReference/API_Validity.html)\u003cbr/\u003ein this API reference and Validity (https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.5)\u003cbr/\u003ein RFC 5280. |\n| **validityNotBefore.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **validityNotBefore.value**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:67,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificateauthority/",title:"CertificateAuthority",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#CertificateAuthority"\u003eacmpca-controller/apis/v1alpha1#CertificateAuthority\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthority\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorities\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthority\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about your private certificate authority (CA). Your\nprivate CA can issue and revoke X.509 digital certificates. Digital certificates\nverify that the entity named in the certificate Subject field owns or controls\nthe public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html)\naction to create your private CA. You must then call the GetCertificateAuthorityCertificate\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_GetCertificateAuthorityCertificate.html)\naction to retrieve a private CA certificate signing request (CSR). Sign the\nCSR with your Amazon Web Services Private CA-hosted or on-premises root or\nsubordinate CA certificate. Call the ImportCertificateAuthorityCertificate\n(https://docs.aws.amazon.com/privateca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html)\naction to import the signed certificate into Certificate Manager (ACM).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificateAuthorityConfiguration: \n csrExtensions: \n keyUsage: \n crlSign: boolean\n dataEncipherment: boolean\n decipherOnly: boolean\n digitalSignature: boolean\n encipherOnly: boolean\n keyAgreement: boolean\n keyCertSign: boolean\n keyEncipherment: boolean\n nonRepudiation: boolean\n subjectInformationAccess:\n accessLocation: \n directoryName: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\n dnsName: string\n ediPartyName: \n nameAssigner: string\n partyName: string\n ipAddress: string\n otherName: \n typeID: string\n value: string\n registeredID: string\n rfc822Name: string\n uniformResourceIdentifier: string\n accessMethod: \n accessMethodType: string\n customObjectIdentifier: string\n keyAlgorithm: string\n signingAlgorithm: string\n subject: \n commonName: string\n country: string\n customAttributes:\n - objectIdentifier: string\n value: string\n distinguishedNameQualifier: string\n generationQualifier: string\n givenName: string\n initials: string\n locality: string\n organization: string\n organizationalUnit: string\n pseudonym: string\n serialNumber: string\n state: string\n surname: string\n title: string\ncertificateAuthorityType: string\nkeyStorageSecurityStandard: string\nrevocationConfiguration: \n crlConfiguration: \n customCNAME: string\n enabled: boolean\n expirationInDays: integer\n s3BucketName: string\n s3ObjectACL: string\n ocspConfiguration: \n enabled: boolean\n ocspCustomCNAME: string\ntags:\n- key: string\n value: string\nusageMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eName and bit size of the private key algorithm, the name of the signing algorithm,\u003cbr/\u003eand X.500 certificate subject information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the certificate extensions to be added to the certificate signing\u003cbr/\u003erequest (CSR).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines one or more purposes for which the key contained in the certificate\u003cbr/\u003ecan be used. Default value for each option is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.crlSign\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.dataEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.decipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.digitalSignature\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.encipherOnly\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyAgreement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyCertSign\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.keyEncipherment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.keyUsage.nonRepudiation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides access information used by the authorityInfoAccess and subjectInfoAccess\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eextensions described in RFC 5280 (https://datatracker.ietf.org/doc/html/rfc5280).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.commonName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.country\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.givenName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.initials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.locality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.organization\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.surname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.directoryName.title\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Electronic Data Interchange (EDI) entity as described in as\u003cbr/\u003edefined in Subject Alternative Name (https://datatracker.ietf.org/doc/html/rfc5280)\u003cbr/\u003ein RFC 5280.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName.nameAssigner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ediPartyName.partyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines a custom ASN.1 X.400 GeneralName using an object identifier (OID)\u003cbr/\u003eand value. The OID must satisfy the regular expression shown below. For more\u003cbr/\u003einformation, see NIST\u0026rsquo;s definition of Object Identifier (OID) (https://csrc.nist.gov/glossary/term/Object_Identifier).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName.typeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.otherName.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.registeredID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.rfc822Name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessLocation.uniformResourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the type and format of extension access. Only one of CustomObjectIdentifier\u003cbr/\u003eor AccessMethodType may be provided. Providing both results in InvalidArgsException.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod.accessMethodType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.csrExtensions.subjectInformationAccess.[].accessMethod.customObjectIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.keyAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.signingAlgorithm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the certificate subject. The Subject field in\u003cbr/\u003ethe certificate identifies the entity that owns or controls the public key\u003cbr/\u003ein the certificate. The entity can be a user, computer, device, or service.\u003cbr/\u003eThe Subject must contain an X.500 distinguished name (DN). A DN is a sequence\u003cbr/\u003eof relative distinguished names (RDNs). The RDNs are separated by commas\u003cbr/\u003ein the certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.commonName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.country\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the X.500 relative distinguished name (RDN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.customAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.distinguishedNameQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.generationQualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.givenName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.initials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.locality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.organization\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.organizationalUnit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.pseudonym\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.serialNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.surname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityConfiguration.subject.title\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of the certificate authority.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyStorageSecurityStandard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies a cryptographic key management compliance standard used for handling\u003cbr/\u003eCA keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: FIPS_140_2_LEVEL_3_OR_HIGHER\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSome Amazon Web Services Regions do not support the default. When creating\u003cbr/\u003ea CA in these Regions, you must provide FIPS_140_2_LEVEL_2_OR_HIGHER as the\u003cbr/\u003eargument for KeyStorageSecurityStandard. Failure to do this results in an\u003cbr/\u003eInvalidArgsException with the message, \u0026ldquo;A certificate authority cannot be\u003cbr/\u003ecreated in this region with the specified security standard.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about security standard support in various Regions, see Storage\u003cbr/\u003eand security compliance of Amazon Web Services Private CA private keys (https://docs.aws.amazon.com/privateca/latest/userguide/data-protection.html#private-keys).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information to enable Online Certificate Status Protocol (OCSP)\u003cbr/\u003esupport, to enable a certificate revocation list (CRL), to enable both, or\u003cbr/\u003eto enable neither. The default is for both certificate validation mechanisms\u003cbr/\u003eto be disabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following requirements apply to revocation configurations.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration disabling CRLs or OCSP must contain only the Enabled=False\u003cbr/\u003e parameter, and will fail if other parameters such as CustomCname or ExpirationInDays\u003cbr/\u003e are included.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * In a CRL configuration, the S3BucketName parameter must conform to Amazon\u003cbr/\u003e S3 bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration containing a custom Canonical Name (CNAME) parameter\u003cbr/\u003e for CRLs or OCSP must conform to RFC2396 (https://www.ietf.org/rfc/rfc2396.txt)\u003cbr/\u003e restrictions on the use of special characters in a CNAME.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * In a CRL or OCSP configuration, the value of a CNAME parameter must\u003cbr/\u003e not include a protocol prefix such as \u0026ldquo;http://\u0026rdquo; or \u0026ldquo;https://\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see the OcspConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_OcspConfiguration.html)\u003cbr/\u003eand CrlConfiguration (https://docs.aws.amazon.com/privateca/latest/APIReference/API_CrlConfiguration.html)\u003cbr/\u003etypes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information for a certificate revocation list (CRL).\u003cbr/\u003eYour private certificate authority (CA) creates base CRLs. Delta CRLs are\u003cbr/\u003enot supported. You can enable CRLs for your new or an existing private CA\u003cbr/\u003eby setting the Enabled parameter to true. Your private CA writes CRLs to\u003cbr/\u003ean S3 bucket that you specify in the S3BucketName parameter. You can hide\u003cbr/\u003ethe name of your bucket by specifying a value for the CustomCname parameter.\u003cbr/\u003eYour private CA copies the CNAME or the S3 bucket name to the CRL Distribution\u003cbr/\u003ePoints extension of each certificate it issues. Your S3 bucket policy must\u003cbr/\u003egive write permission to Amazon Web Services Private CA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Web Services Private CA assets that are stored in Amazon S3 can be\u003cbr/\u003eprotected with encryption. For more information, see Encrypting Your CRLs\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/userguide/PcaCreateCa.html#crl-encryption).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour private CA uses the value in the ExpirationInDays parameter to calculate\u003cbr/\u003ethe nextUpdate field in the CRL. The CRL is refreshed prior to a certificate\u0026rsquo;s\u003cbr/\u003eexpiration date or when a certificate is revoked. When a certificate is revoked,\u003cbr/\u003eit appears in the CRL until the certificate expires, and then in one additional\u003cbr/\u003eCRL after expiration, and it always appears in the audit report.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA CRL is typically updated approximately 30 minutes after a certificate is\u003cbr/\u003erevoked. If for any reason a CRL update fails, Amazon Web Services Private\u003cbr/\u003eCA makes further attempts every 15 minutes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCRLs contain the following fields:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Version: The current version number defined in RFC 5280 is V2. The integer\u003cbr/\u003e value is 0x1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Algorithm: The name of the algorithm used to sign the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Issuer: The X.500 distinguished name of your private CA that issued\u003cbr/\u003e the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Last Update: The issue date and time of this CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Next Update: The day and time by which the next CRL will be issued.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Revoked Certificates: List of revoked certificates. Each list item contains\u003cbr/\u003e the following information. Serial Number: The serial number, in hexadecimal\u003cbr/\u003e format, of the revoked certificate. Revocation Date: Date and time the\u003cbr/\u003e certificate was revoked. CRL Entry Extensions: Optional extensions for\u003cbr/\u003e the CRL entry. X509v3 CRL Reason Code: Reason the certificate was revoked.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CRL Extensions: Optional extensions for the CRL. X509v3 Authority Key\u003cbr/\u003e Identifier: Identifies the public key associated with the private key\u003cbr/\u003e used to sign the certificate. X509v3 CRL Number:: Decimal sequence number\u003cbr/\u003e for the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Algorithm: Algorithm used by your private CA to sign the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Signature Value: Signature computed over the CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertificate revocation lists created by Amazon Web Services Private CA are\u003cbr/\u003eDER-encoded. You can use the following OpenSSL command to list a CRL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eopenssl crl -inform DER -text -in crl_path -noout\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Planning a certificate revocation list (CRL) (https://docs.aws.amazon.com/privateca/latest/userguide/crl-planning.html)\u003cbr/\u003ein the Amazon Web Services Private Certificate Authority User Guide\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.customCNAME\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.expirationInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.s3BucketName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.crlConfiguration.s3ObjectACL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information to enable and configure Online Certificate Status Protocol\u003cbr/\u003e(OCSP) for validating certificate revocation status.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you revoke a certificate, OCSP responses may take up to 60 minutes to\u003cbr/\u003ereflect the new status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevocationConfiguration.ocspConfiguration.ocspCustomCNAME\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eKey-value pairs that will be attached to the new private CA. You can associate\u003cbr/\u003eup to 50 tags with a private CA. For information using tags with IAM to manage\u003cbr/\u003epermissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are labels that you can use to identify and organize your private CAs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEach tag consists of a key and an optional value. You can associate up to\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e50 tags with a private CA. To add one or more tags to a private CA, call\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe TagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_TagCertificateAuthority.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaction. To remove a tag, call the UntagCertificateAuthority (https://docs.aws.amazon.com/privateca/latest/APIReference/API_UntagCertificateAuthority.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaction.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the CA issues general-purpose certificates that typically\u003cbr/\u003erequire a revocation mechanism, or short-lived certificates that may optionally\u003cbr/\u003eomit revocation because they expire quickly. Short-lived certificate validity\u003cbr/\u003eis limited to seven days.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is GENERAL_PURPOSE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncsr: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecsr\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:68,href:"https://aws-controllers-k8s.github.io/community/reference/acmpca/v1alpha1/certificateauthorityactivation/",title:"CertificateAuthorityActivation",description:null,content:'\u003cp\u003e\u003ccode\u003eacmpca.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/acmpca-controller/apis/v1alpha1#CertificateAuthorityActivation"\u003eacmpca-controller/apis/v1alpha1#CertificateAuthorityActivation\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityActivation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCertificateAuthorityActivationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorityactivations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecertificateauthorityactivation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecertificate: \n key: string\n name: string\n namespace: string\ncertificateAuthorityARN: string\ncertificateAuthorityRef: \n from: \n name: string\ncertificateChain: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificate.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority\u003cbr/\u003e(https://docs.aws.amazon.com/privateca/latest/APIReference/API_CreateCertificateAuthority.html).\u003cbr/\u003eThis must be of the form:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthorityRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateChain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA PEM-encoded file that contains all of your certificates, other than the\u003cbr/\u003ecertificate you\u0026rsquo;re importing, chaining up to your root CA. Your Amazon Web\u003cbr/\u003eServices Private CA-hosted or on-premises root certificate is the last in\u003cbr/\u003ethe chain, and each certificate in the chain signs the one preceding.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter must be supplied when you import a subordinate CA. When you\u003cbr/\u003eimport a root CA, there is no chain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:69,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#Cluster"\u003eecs-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA regional grouping of one or more container instances where you can run\ntask requests. Each account receives a default cluster the first time you\nuse the Amazon ECS service, but you may also create other clusters. Clusters\nmay contain more than one instance type simultaneously.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacityProviders:\n- string\nconfiguration: \n executeCommandConfiguration: \n kmsKeyID: string\n logConfiguration: \n cloudWatchEncryptionEnabled: boolean\n cloudWatchLogGroupName: string\n s3BucketName: string\n s3EncryptionEnabled: boolean\n s3KeyPrefix: string\n logging: string\ndefaultCapacityProviderStrategy:\n- base: integer\n capacityProvider: string\n weight: integer\nname: string\nserviceConnectDefaults: \n namespace: string\nsettings:\n- name: string\n value: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe short name of one or more capacity providers to associate with the cluster.\u003cbr/\u003eA capacity provider must be associated with a cluster before it can be included\u003cbr/\u003eas part of the default capacity provider strategy of the cluster or used\u003cbr/\u003ein a capacity provider strategy when calling the CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)\u003cbr/\u003eor RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)\u003cbr/\u003eactions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\u003cbr/\u003eprovider must be created but not associated with another cluster. New Auto\u003cbr/\u003eScaling group capacity providers can be created with the CreateCapacityProvider\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html)\u003cbr/\u003eAPI operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\u003cbr/\u003ecapacity providers. The Fargate capacity providers are available to all accounts\u003cbr/\u003eand only need to be associated with a cluster to be used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe PutCapacityProvider (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html)\u003cbr/\u003eAPI operation is used to update the list of available capacity providers\u003cbr/\u003efor a cluster after the cluster is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the execute command configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the results of the execute command actions. The\u003cbr/\u003elogs can be sent to CloudWatch Logs or an Amazon S3 bucket.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.cloudWatchEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.cloudWatchLogGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3BucketName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3EncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logConfiguration.s3KeyPrefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration.executeCommandConfiguration.logging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultCapacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe capacity provider strategy to set as the default for the cluster. After\u003cbr/\u003ea default capacity provider strategy is set for a cluster, when you call\u003cbr/\u003ethe CreateService (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html)\u003cbr/\u003eor RunTask (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html)\u003cbr/\u003eAPIs with no capacity provider strategy or launch type specified, the default\u003cbr/\u003ecapacity provider strategy for the cluster is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a default capacity provider strategy isn\u0026rsquo;t defined for a cluster when\u003cbr/\u003eit was created, it can be defined later with the PutClusterCapacityProviders\u003cbr/\u003eAPI operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultCapacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003edefaultCapacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edefaultCapacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edefaultCapacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster. If you don\u0026rsquo;t specify a name for your cluster, you\u003cbr/\u003ecreate a cluster that\u0026rsquo;s named default. Up to 255 letters (uppercase and lowercase),\u003cbr/\u003enumbers, underscores, and hyphens are allowed. |\n| \u003cstrong\u003eserviceConnectDefaults\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUse this parameter to set a default Service Connect namespace. After you\u003cbr/\u003eset a default Service Connect namespace, any new services with Service Connect\u003cbr/\u003eturned on that are created in the cluster are added as client services in\u003cbr/\u003ethe namespace. This setting only applies to new services that set the enabled\u003cbr/\u003eparameter to true in the ServiceConnectConfiguration. You can set the namespace\u003cbr/\u003eof each service individually in the ServiceConnectConfiguration to override\u003cbr/\u003ethis default parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eserviceConnectDefaults.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe setting to use when creating a cluster. This parameter is used to turn\u003cbr/\u003eon CloudWatch Container Insights for a cluster. If this value is specified,\u003cbr/\u003eit overrides the containerInsights value set with PutAccountSetting or PutAccountSettingDefault. |\n| \u003cstrong\u003esettings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings to use when creating a cluster. This parameter is used to turn\non CloudWatch Container Insights for a cluster. || \u003cstrong\u003esettings.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esettings.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the cluster to help you categorize and organize\u003cbr/\u003ethem. Each tag consists of a key and an optional value. You define both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactiveServicesCount: integer\nattachments:\n details:\n - name: string\n value: string\n id: string\n status: string\n type: string\nattachmentsStatus: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\npendingTasksCount: integer\nregisteredContainerInstancesCount: integer\nrunningTasksCount: integer\nstatistics:\n- name: string\n value: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveServicesCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of services that are running on the cluster in an ACTIVE state.\u003cbr/\u003eYou can view these services with ListServices.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe resources attached to a cluster. When using a capacity provider with\u003cbr/\u003ea cluster, the capacity provider and associated resources are returned as\u003cbr/\u003ecluster attachments.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container instance or task attachment.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].details.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].details.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachmentsStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the capacity providers associated with the cluster. The following\u003cbr/\u003eare the states that are returned.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_IN_PROGRESS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe available capacity providers for the cluster are updating.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_COMPLETE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe capacity providers have successfully updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUPDATE_FAILED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe capacity provider updates failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingTasksCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the PENDING state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredContainerInstancesCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of container instances registered into the cluster. This includes\u003cbr/\u003econtainer instances in both ACTIVE and DRAINING status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erunningTasksCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the RUNNING state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAdditional information about your clusters that are separated by launch type.\u003cbr/\u003eThey include the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * runningEC2TasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RunningFargateTasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pendingEC2TasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pendingFargateTasksCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * activeEC2ServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * activeFargateServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * drainingEC2ServiceCount\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * drainingFargateServiceCount\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatistics.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the cluster. The following are the possible states that are\u003cbr/\u003ereturned.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eACTIVE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster is ready to accept tasks and if applicable you can register container\u003cbr/\u003einstances with the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePROVISIONING\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider are being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDEPROVISIONING\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider are being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFAILED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has capacity providers that are associated with it and the resources\u003cbr/\u003eneeded for the capacity provider have failed to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eINACTIVE\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe cluster has been deleted. Clusters with an INACTIVE status may remain\u003cbr/\u003ediscoverable in your account for a period of time. However, this behavior\u003cbr/\u003eis subject to change in the future. We don\u0026rsquo;t recommend that you rely on INACTIVE\u003cbr/\u003eclusters persisting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:70,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Cluster"\u003eeks-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Amazon EKS cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessConfig: \n authenticationMode: string\n bootstrapClusterCreatorAdminPermissions: boolean\nclientRequestToken: string\nencryptionConfig:\n provider: \n keyARN: string\n keyRef: \n from: \n name: string\n resources:\n - string\nkubernetesNetworkConfig: \n ipFamily: string\n serviceIPv4CIDR: string\nlogging: \n clusterLogging:\n - enabled: boolean\n types:\n - string\nname: string\noutpostConfig: \n controlPlaneInstanceType: string\n controlPlanePlacement: \n groupName: string\n outpostARNs:\n - string\nresourcesVPCConfig: \n endpointPrivateAccess: boolean\n endpointPublicAccess: boolean\n publicAccessCIDRs:\n - string\n securityGroupIDs:\n - string\n securityGroupRefs:\n from: \n name: string\n subnetIDs:\n - string\n subnetRefs:\n from: \n name: string\nroleARN: string\nroleRef: \n from: \n name: string\ntags: {}\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig.authenticationMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessConfig.bootstrapClusterCreatorAdminPermissions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for KeyARN\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].provider.keyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].resources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfig.[].resources.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesNetworkConfig.ipFamily\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekubernetesNetworkConfig.serviceIPv4CIDR\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnable or disable exporting the Kubernetes control plane logs for your cluster\u003cbr/\u003eto CloudWatch Logs. By default, cluster control plane logs aren\u0026rsquo;t exported\u003cbr/\u003eto CloudWatch Logs. For more information, see Amazon EKS Cluster control\u003cbr/\u003eplane logs (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html)\u003cbr/\u003ein the Amazon EKS User Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCloudWatch Logs ingestion, archive storage, and data scanning rates apply\u003cbr/\u003eto exported control plane logs. For more information, see CloudWatch Pricing\u003cbr/\u003e(http://aws.amazon.com/cloudwatch/pricing/).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the enabled or disabled Kubernetes control plane logs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor your cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[].types\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogging.clusterLogging.[].types.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the configuration of your local Amazon EKS cluster\u003cbr/\u003eon an Amazon Web Services Outpost. Before creating a local cluster on an\u003cbr/\u003eOutpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts\u003cbr/\u003e(https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-local-cluster-overview.html)\u003cbr/\u003ein the Amazon EKS User Guide. This object isn\u0026rsquo;t available for creating Amazon\u003cbr/\u003eEKS clusters on the Amazon Web Services cloud.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlaneInstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlanePlacement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe placement configuration for all the control plane instances of your local\u003cbr/\u003eAmazon EKS cluster on an Amazon Web Services Outpost. For more information,\u003cbr/\u003esee Capacity considerations (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.controlPlanePlacement.groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.outpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostConfig.outpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.endpointPrivateAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.endpointPublicAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.publicAccessCIDRs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.publicAccessCIDRs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourcesVPCConfig.securityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **resourcesVPCConfig.securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eresourcesVPCConfig.securityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eresourcesVPCConfig.subnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eresourcesVPCConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eresourcesVPCConfig.subnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetIDs |\n| \u003cstrong\u003eresourcesVPCConfig.subnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **resourcesVPCConfig.subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eresourcesVPCConfig.subnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that provides permissions\u003cbr/\u003efor the Kubernetes control plane to make calls to Amazon Web Services API\u003cbr/\u003eoperations on your behalf. For more information, see Amazon EKS Service IAM\u003cbr/\u003eRole (https://docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html)\u003cbr/\u003ein the Amazon EKS User Guide . |\n| \u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\n| \u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe desired Kubernetes version for your cluster. If you don\u0026rsquo;t specify a value\u003cbr/\u003ehere, the default version available in Amazon EKS is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default version might not be the latest version available. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncertificateAuthority: \n data: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconnectorConfig: \n activationCode: string\n activationExpiry: string\n activationID: string\n provider: string\n roleARN: string\ncreatedAt: string\nendpoint: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nid: string\nidentity: \n oidc: \n issuer: string\nplatformVersion: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe certificate-authority-data for your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateAuthority.data\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration used to connect to a cluster for registration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationExpiry\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.activationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.provider\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectorConfig.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint for your Kubernetes API server.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the health of your local Amazon EKS cluster on an\u003cbr/\u003eAmazon Web Services Outpost. This object isn\u0026rsquo;t available for clusters on\u003cbr/\u003ethe Amazon Web Services cloud.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eYou can\u0026rsquo;t use this API with an Amazon EKS cluster on the Amazon Web Services\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecloud.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe identity provider information for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity.oidc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the OpenID Connect (https://openid.net/connect/) (OIDC)\u003cbr/\u003eidentity provider information for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidentity.oidc.issuer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform version of your Amazon EKS cluster. For more information about\u003cbr/\u003eclusters deployed on the Amazon Web Services Cloud, see Platform versions\u003cbr/\u003e(https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide . For more information about local clusters\u003cbr/\u003edeployed on an Outpost, see Amazon EKS local cluster platform versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide .\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:71,href:"https://aws-controllers-k8s.github.io/community/reference/kafka/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003ekafka.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kafka-controller/apis/v1alpha1#Cluster"\u003ekafka-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eReturns information about a cluster of either the provisioned or the serverless\ntype.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebrokerNodeGroupInfo: \n brokerAZDistribution: string\n clientSubnets:\n - string\n connectivityInfo: \n publicAccess: \n type_: string\n instanceType: string\n securityGroups:\n - string\n storageInfo: \n ebsStorageInfo: \n provisionedThroughput: \n enabled: boolean\n volumeThroughput: integer\n volumeSize: integer\nclientAuthentication: \n sasl: \n iam: \n enabled: boolean\n scram: \n enabled: boolean\n tls: \n certificateAuthorityARNList:\n - string\n enabled: boolean\n unauthenticated: \n enabled: boolean\nconfigurationInfo: \n arn: string\n revision: integer\nencryptionInfo: \n encryptionAtRest: \n dataVolumeKMSKeyID: string\n encryptionInTransit: \n clientBroker: string\n inCluster: boolean\nenhancedMonitoring: string\nkafkaVersion: string\nloggingInfo: \n brokerLogs: \n cloudWatchLogs: \n enabled: boolean\n logGroup: string\n firehose: \n deliveryStream: string\n enabled: boolean\n s3: \n bucket: string\n enabled: boolean\n prefix: string\nname: string\nnumberOfBrokerNodes: integer\nopenMonitoring: \n prometheus: \n jmxExporter: \n enabledInBroker: boolean\n nodeExporter: \n enabledInBroker: boolean\nstorageMode: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the brokers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.brokerAZDistribution\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution of broker nodes across Availability Zones. By default, broker\u003cbr/\u003enodes are distributed among the Availability Zones of your Region. Currently,\u003cbr/\u003ethe only supported value is DEFAULT. You can either specify this value explicitly\u003cbr/\u003eor leave it out.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.clientSubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.clientSubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.connectivityInfo.publicAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eBroker public access control.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**brokerNodeGroupInfo.connectivityInfo.publicAccess.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the EBS storage volumes attached to Apache Kafka\u003cbr/\u003ebroker nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about provisioned throughput for EBS storage volumes\u003cbr/\u003eattached to kafka broker nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.provisionedThroughput.volumeThroughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebrokerNodeGroupInfo.storageInfo.ebsStorageInfo.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIncludes all client authentication related information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.iam\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.iam.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.scram\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.sasl.scram.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails for client authentication using TLS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls.certificateAuthorityARNList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.tls.certificateAuthorityARNList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.unauthenticated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about unauthenticated traffic to the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientAuthentication.unauthenticated.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the configuration that you want MSK to use for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationInfo.revision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIncludes all encryption-related information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionAtRest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data-volume encryption details.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionAtRest.dataVolumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for encrypting data in transit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit.clientBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eClient-broker encryption in transit setting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionInfo.encryptionInTransit.inCluster\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the level of monitoring for the MSK cluster. The possible values\u003cbr/\u003eare DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, and PER_TOPIC_PER_PARTITION.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekafkaVersion\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of Apache Kafka.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eLoggingInfo details.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe broker logs configuration for this MSK cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails of the CloudWatch Logs destination for broker logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.cloudWatchLogs.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFirehose details for BrokerLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.firehose.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the Amazon S3 destination for broker logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingInfo.brokerLogs.s3.prefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfBrokerNodes\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of Apache Kafka broker nodes in the Amazon MSK cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for open monitoring.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003ePrometheus settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.jmxExporter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want to enable or disable the JMX Exporter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.jmxExporter.enabledInBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.nodeExporter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want to enable or disable the Node Exporter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenMonitoring.prometheus.nodeExporter.enabledInBroker\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis controls storage mode for supported storage tiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCreate tags when creating the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the cluster. The possible states are ACTIVE, CREATING, DELETING,\u003cbr/\u003eFAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:72,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/cluster/",title:"Cluster",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#Cluster"\u003ememorydb-controller/apis/v1alpha1#Cluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains all of the attributes of a specific cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaclName: string\naclRef: \n from: \n name: string\nautoMinorVersionUpgrade: boolean\ndescription: string\nengineVersion: string\nkmsKeyID: string\nmaintenanceWindow: string\nname: string\nnodeType: string\nnumReplicasPerShard: integer\nnumShards: integer\nparameterGroupName: string\nparameterGroupRef: \n from: \n name: string\nport: integer\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nsnapshotARNs:\n- string\nsnapshotName: string\nsnapshotRef: \n from: \n name: string\nsnapshotRetentionLimit: integer\nsnapshotWindow: string\nsnsTopicARN: string\nsnsTopicRef: \n from: \n name: string\nsubnetGroupName: string\nsubnetGroupRef: \n from: \n name: string\ntags:\n- key: string\n value: string\ntlsEnabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Access Control List to associate with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhen set to true, the cluster will automatically receive minor engine version upgrades after launch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional description of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the Redis engine to be used for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster. This value must be unique as it also serves as the cluster identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the nodes in the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumReplicasPerShard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of replicas to apply to each shard. The default value is 1. The maximum is 5.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards the cluster will contain. The default value is 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group associated with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which each of the nodes accepts connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of security group names to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new cluster. The Amazon S3 object name in the ARN cannot contain any commas.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. \u003cbr/\u003e Example: 05:00-09:00 \u003cbr/\u003e If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the subnet group to be used for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag to enable in-transit encryption on the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallowedScaleDownNodeTypes:\n- string\nallowedScaleUpNodeTypes:\n- string\navailabilityMode: string\nclusterEndpoint: \n address: string\n port: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nenginePatchVersion: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nnumberOfShards: integer\nparameterGroupStatus: string\npendingUpdates: \n acls: \n aclToApply: string\n resharding: \n slotMigration: \n progressPercentage: number\n serviceUpdates:\n - serviceUpdateName: string\n status: string\nsecurityGroups:\n- securityGroupID: string\n status: string\nshards:\n- name: string\n nodes:\n - availabilityZone: string\n createTime: string\n endpoint: \n address: string\n port: integer\n name: string\n status: string\n numberOfNodes: integer\n slots: string\n status: string\nsnsTopicStatus: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownNodeTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list node types which you can use to scale down your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownNodeTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleUpNodeTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe cluster\u0026rsquo;s configuration endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenginePatchVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Redis engine patch version used by the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards in the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the parameter group used by the cluster, for example \u0026lsquo;active\u0026rsquo; or \u0026lsquo;applying\u0026rsquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA group of settings that are currently being applied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.acls\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the ACL update\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.acls.aclToApply\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the online resharding\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding.slotMigration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the progress of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.resharding.slotMigration.progressPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUpdate action that has yet to be processed for the corresponding apply/stop request\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingUpdates.serviceUpdates.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of security groups used by the cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single security group and its status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of shards that are members of the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an individual node within a cluster. Each node runs its own instance of the cluster\u0026rsquo;s protocol-compliant caching software.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].createTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to the cluster and its nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].endpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].nodes.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].numberOfNodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshards.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SNS topic must be in Active status to receive notifications\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the cluster. For example, Available, Updating, Creating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:73,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/codesigningconfig/",title:"CodeSigningConfig",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#CodeSigningConfig"\u003elambda-controller/apis/v1alpha1#CodeSigningConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCodeSigningConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eCodeSigningConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecodesigningconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ecodesigningconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails about a Code signing configuration (https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallowedPublishers: \n signingProfileVersionARNs:\n - string\ncodeSigningPolicies: \n untrustedArtifactOnDeployment: string\ndescription: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSigning profiles for this code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers.signingProfileVersionARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPublishers.signingProfileVersionARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningPolicies.untrustedArtifactOnDeployment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDescriptive name for this code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncodeSigningConfigID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlastModified: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningConfigID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique identifer for the Code signing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Code signing configuration was last modified,\u003cbr/\u003ein ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:74,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/dataqualityjobdefinition/",title:"DataQualityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#DataQualityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#DataQualityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDataQualityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDataQualityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edataqualityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edataqualityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edataQualityAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n environment: {}\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n recordPreprocessorSourceURI: string\ndataQualityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\n statisticsResource: \n s3URI: string\ndataQualityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\ndataQualityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\njobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the container that runs the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the constraints and baselines for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.statisticsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe statistics resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityBaselineConfig.statisticsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of inputs for the monitoring job. Currently endpoints are supported\u003cbr/\u003eas monitoring inputs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the monitoring job definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies networking configuration for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:75,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbcluster/",title:"DBCluster",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBCluster"\u003edocumentdb-controller/apis/v1alpha1#DBCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about a cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eavailabilityZones:\n- string\nbackupRetentionPeriod: integer\ndbClusterIdentifier: string\ndbClusterParameterGroupName: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndeletionProtection: boolean\ndestinationRegion: string\nenableCloudwatchLogsExports:\n- string\nengine: string\nengineVersion: string\nglobalClusterIdentifier: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUsername: string\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\nsnapshotIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageType: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon EC2 Availability Zones that instances in the cluster can\u003cbr/\u003ebe created in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: my-cluster\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster parameter group to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA subnet group to associate with this cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mySubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether this cluster can be deleted. If DeletionProtection is enabled,\u003cbr/\u003ethe cluster cannot be deleted unless it is modified and DeletionProtection\u003cbr/\u003eis disabled. DeletionProtection protects clusters from being accidentally\u003cbr/\u003edeleted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that need to be enabled for exporting to Amazon CloudWatch\u003cbr/\u003eLogs. You can enable audit logs or profiler logs. For more information, see\u003cbr/\u003eAuditing Amazon DocumentDB Events (https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html)\u003cbr/\u003eand Profiling Amazon DocumentDB Operations (https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use. The \u0026ndash;engine-version will\u003cbr/\u003edefault to the latest major engine version. For production workloads, we\u003cbr/\u003erecommend explicitly declaring this parameter with the intended major engine\u003cbr/\u003eversion.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier of the new global cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key identifier for an encrypted cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption\u003cbr/\u003ekey. If you are creating a cluster using the same Amazon Web Services account\u003cbr/\u003ethat owns the KMS encryption key that is used to encrypt the new cluster,\u003cbr/\u003eyou can use the KMS key alias instead of the ARN for the KMS encryption key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an encryption key is not specified in KmsKeyId:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the StorageEncrypted parameter is true, Amazon DocumentDB uses your\u003cbr/\u003e default encryption key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS creates the default encryption key for your Amazon Web Services account.\u003cbr/\u003eYour Amazon Web Services account has a different default encryption key for\u003cbr/\u003eeach Amazon Web Services Regions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master database user. This password can contain any\u003cbr/\u003eprintable ASCII character except forward slash (/), double quote (\u0026quot;), or\u003cbr/\u003ethe \u0026ldquo;at\u0026rdquo; symbol (@).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 100 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the master user for the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be from 1 to 63 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot be a reserved word for the chosen database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the instances in the cluster accept connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNot currently supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled using the BackupRetentionPeriod parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe weekly time range during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the snapshot or cluster snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use either the name or the Amazon Resource Name (ARN) to specify\u003cbr/\u003ea cluster snapshot. However, you can use only the ARN to specify a snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the cluster is encrypted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe storage type to associate with the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information on storage types for Amazon DocumentDB clusters, see Cluster\u003cbr/\u003estorage configurations in the Amazon DocumentDB Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for storage type - standard\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 VPC security groups to associate with this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociatedRoles:\n- roleARN: string\n status: string\ncloneGroupID: string\nclusterCreateTime: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndbClusterMembers:\n- dbClusterParameterGroupStatus: string\n dbInstanceIdentifier: string\n isClusterWriter: boolean\n promotionTier: integer\ndbClusterParameterGroup: string\ndbClusterResourceID: string\ndbSubnetGroup: string\nearliestRestorableTime: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: string\nhostedZoneID: string\nlatestRestorableTime: string\nmultiAZ: boolean\npercentProgress: string\nreadReplicaIdentifiers:\n- string\nreaderEndpoint: string\nreplicationSourceIdentifier: string\nstatus: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of the Identity and Access Management (IAM) roles that are\u003cbr/\u003eassociated with the cluster. (IAM) roles that are associated with a cluster\u003cbr/\u003egrant permission for the cluster to access other Amazon Web Services services\u003cbr/\u003eon your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Identity and Access Management (IAM) role that is associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith a cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloneGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the clone group to which the DB cluster is associated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the time when the cluster was created, in Universal Coordinated\u003cbr/\u003eTime (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of instances that make up the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about an instance that is part of a cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].isClusterWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].promotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the cluster parameter group for the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the cluster.\u003cbr/\u003eThis identifier is found in CloudTrail log entries whenever the KMS key for\u003cbr/\u003ethe cluster is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group that is associated with the cluster,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this cluster is configured to export to Amazon CloudWatch\u003cbr/\u003eLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the cluster has instances in multiple Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epercentProgress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the progress of the operation as a percentage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the secondary clusters that are associated\u003cbr/\u003ewith this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source cluster if this cluster is a secondary\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of virtual private cloud (VPC) security groups that the cluster\u003cbr/\u003ebelongs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed as a response element for queries on virtual private cloud (VPC) security\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup membership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:76,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbcluster/",title:"DBCluster",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBCluster"\u003erds-controller/apis/v1alpha1#DBCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.\u003c/p\u003e\n\u003cp\u003eFor an Amazon Aurora DB cluster, this data type is used as a response element\nin the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,\nModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot,\nRestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.\u003c/p\u003e\n\u003cp\u003eFor a Multi-AZ DB cluster, this data type is used as a response element in\nthe operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster,\nModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.\u003c/p\u003e\n\u003cp\u003eFor more information on Amazon Aurora DB clusters, see What is Amazon Aurora?\n(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html)\nin the Amazon Aurora User Guide.\u003c/p\u003e\n\u003cp\u003eFor more information on Multi-AZ DB clusters, see Multi-AZ deployments with\ntwo readable standby DB instances (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\nin the Amazon RDS User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocatedStorage: integer\nautoMinorVersionUpgrade: boolean\navailabilityZones:\n- string\nbacktrackWindow: integer\nbackupRetentionPeriod: integer\ncharacterSetName: string\ncopyTagsToSnapshot: boolean\ndatabaseName: string\ndbClusterIdentifier: string\ndbClusterInstanceClass: string\ndbClusterParameterGroupName: string\ndbClusterParameterGroupRef: \n from: \n name: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndbSystemID: string\ndeletionProtection: boolean\ndestinationRegion: string\ndomain: string\ndomainIAMRoleName: string\nenableCloudwatchLogsExports:\n- string\nenableGlobalWriteForwarding: boolean\nenableHTTPEndpoint: boolean\nenableIAMDatabaseAuthentication: boolean\nenablePerformanceInsights: boolean\nengine: string\nengineMode: string\nengineVersion: string\nglobalClusterIdentifier: string\niops: integer\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nmanageMasterUserPassword: boolean\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUserSecretKMSKeyID: string\nmasterUserSecretKMSKeyRef: \n from: \n name: string\nmasterUsername: string\nmonitoringInterval: integer\nmonitoringRoleARN: string\nnetworkType: string\noptionGroupName: string\nperformanceInsightsKMSKeyID: string\nperformanceInsightsRetentionPeriod: integer\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\npubliclyAccessible: boolean\nreplicationSourceIdentifier: string\nscalingConfiguration: \n autoPause: boolean\n maxCapacity: integer\n minCapacity: integer\n secondsBeforeTimeout: integer\n secondsUntilAutoPause: integer\n timeoutAction: string\nserverlessV2ScalingConfiguration: \n maxCapacity: number\n minCapacity: number\nsnapshotIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageType: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of storage in gibibytes (GiB) to allocate to each DB instance\u003cbr/\u003ein the Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether minor engine upgrades are applied automatically\u003cbr/\u003eto the DB cluster during the maintenance window. By default, minor engine\u003cbr/\u003eupgrades are applied automatically.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Availability Zones (AZs) where DB instances in the DB cluster can\u003cbr/\u003ebe created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information on Amazon Web Services Regions and Availability Zones, see\u003cbr/\u003eChoosing the Regions and Availability Zones (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which automated backups are retained.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be a value from 1 to 35\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echaracterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB cluster should be associated with the\u003cbr/\u003especified CharacterSet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy all tags from the DB cluster to snapshots\u003cbr/\u003eof the DB cluster. The default is not to copy them.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatabaseName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for your database of up to 64 alphanumeric characters. If you do\u003cbr/\u003enot provide a name, Amazon RDS doesn\u0026rsquo;t create a database in the DB cluster\u003cbr/\u003eyou are creating.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB cluster identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: my-cluster1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of each DB instance in the Multi-AZ DB cluster,\u003cbr/\u003efor example db.m6gd.xlarge. Not all DB instance classes are available in\u003cbr/\u003eall Amazon Web Services Regions, or for all database engines.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the full list of DB instance classes and availability for your engine,\u003cbr/\u003esee DB instance class (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB cluster parameter group to associate with this DB cluster.\u003cbr/\u003eIf you do not specify a value, then the default DB cluster parameter group\u003cbr/\u003efor the specified DB engine and version is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If supplied, must match the name of an existing DB cluster parameter\u003cbr/\u003e group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA DB subnet group to associate with this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eReserved for future use.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster has deletion protection enabled.\u003cbr/\u003eThe database can\u0026rsquo;t be deleted when deletion protection is enabled. By default,\u003cbr/\u003edeletion protection isn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Active Directory directory ID to create the DB cluster in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication\u003cbr/\u003eto authenticate users that connect to the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Kerberos authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainIAMRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the name of the IAM role to be used when making API calls to the\u003cbr/\u003eDirectory Service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of log types that need to be enabled for exporting to CloudWatch\u003cbr/\u003eLogs. The values in the list depend on the DB engine being used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are postgresql and upgrade.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible value is postgresql.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about exporting CloudWatch Logs for Amazon RDS, see\u003cbr/\u003ePublishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about exporting CloudWatch Logs for Amazon Aurora, see\u003cbr/\u003ePublishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableHTTPEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable the HTTP endpoint for an Aurora\u003cbr/\u003eServerless v1 DB cluster. By default, the HTTP endpoint is disabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen enabled, the HTTP endpoint provides a connectionless web service API\u003cbr/\u003efor running SQL queries on the Aurora Serverless v1 DB cluster. You can also\u003cbr/\u003equery your database from inside the RDS console with the query editor.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableIAMDatabaseAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts. By default, mapping\u003cbr/\u003eisn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see IAM Database Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenablePerformanceInsights\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to turn on Performance Insights for the DB\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB engine mode of the DB cluster, either provisioned or serverless.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe serverless engine mode only applies for Aurora Serverless v1 DB clusters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLimitations and requirements apply to some DB engine modes. For more information,\u003cbr/\u003esee the following sections in the Amazon Aurora User Guide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Requirements for Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of parallel query (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Limitations of Aurora global databases (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible)\u003cbr/\u003eand version 3 (MySQL 8.0-compatible), use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine aurora-mysql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can supply either 5.7 or 8.0 to use the default engine version for Aurora\u003cbr/\u003eMySQL version 2 or version 3, respectively.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for Aurora PostgreSQL, use the\u003cbr/\u003efollowing command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine aurora-postgresql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for RDS for MySQL, use the following\u003cbr/\u003ecommand:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine mysql \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available engine versions for RDS for PostgreSQL, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;engine postgres \u0026ndash;query \u0026ldquo;DBEngineVersions[].EngineVersion\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Database engine updates for Amazon Aurora MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon Aurora PostgreSQL releases and engine versions\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for MySQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for PostgreSQL (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe global cluster ID of an Aurora cluster that becomes the primary cluster\u003cbr/\u003ein the new global database cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of Provisioned IOPS (input/output operations per second) to be\u003cbr/\u003einitially allocated for each DB instance in the Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about valid IOPS values, see Provisioned IOPS storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must be a multiple between .5 and 50 of the storage amount for\u003cbr/\u003ethe DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for an encrypted DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a KMS key isn\u0026rsquo;t specified in KmsKeyId:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If ReplicationSourceIdentifier identifies an encrypted source, then\u003cbr/\u003e Amazon RDS will use the KMS key used to encrypt the source. Otherwise,\u003cbr/\u003e Amazon RDS will use your default KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier\u003cbr/\u003e isn\u0026rsquo;t specified, then Amazon RDS will use your default KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create a read replica of an encrypted DB cluster in another Amazon\u003cbr/\u003eWeb Services Region, you must set KmsKeyId to a KMS key identifier that is\u003cbr/\u003evalid in the destination Amazon Web Services Region. This KMS key is used\u003cbr/\u003eto encrypt the read replica in that Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanageMasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to manage the master user password with Amazon\u003cbr/\u003eWeb Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide and Password management with Amazon Web Services\u003cbr/\u003eSecrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t manage the master user password with Amazon Web Services Secrets\u003cbr/\u003e Manager if MasterUserPassword is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master database user. This password can contain any\u003cbr/\u003eprintable ASCII character except \u0026ldquo;/\u0026rdquo;, \u0026ldquo;\u0026quot;\u0026rdquo;, or \u0026ldquo;@\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified if ManageMasterUserPassword is turned on.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically\u003cbr/\u003egenerated and managed in Amazon Web Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is valid only if the master user password is managed by RDS\u003cbr/\u003ein Amazon Web Services Secrets Manager for the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager\u003cbr/\u003eKMS key is used to encrypt the secret. If the secret is in a different Amazon\u003cbr/\u003eWeb Services account, then you can\u0026rsquo;t use the aws/secretsmanager KMS key to\u003cbr/\u003eencrypt the secret, and you must use a customer managed KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the master user for the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 16 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a reserved word for the chosen database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe interval, in seconds, between points when Enhanced Monitoring metrics\u003cbr/\u003eare collected for the DB cluster. To turn off collecting Enhanced Monitoring\u003cbr/\u003emetrics, specify 0. The default is 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringRoleArn is specified, also set MonitoringInterval to a value\u003cbr/\u003eother than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0, 1, 5, 10, 15, 30, 60\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) for the IAM role that permits RDS to send\u003cbr/\u003eEnhanced Monitoring metrics to Amazon CloudWatch Logs. An example is arn:aws:iam:123456789012:role/emaccess.\u003cbr/\u003eFor information on creating a monitoring role, see Setting up and enabling\u003cbr/\u003eEnhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn\u003cbr/\u003evalue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe network type is determined by the DBSubnetGroup specified for the DB\u003cbr/\u003ecluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and\u003cbr/\u003ethe IPv6 protocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB cluster should be associated with the\u003cbr/\u003especified option group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDB clusters are associated with a default option group that can\u0026rsquo;t be modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for encryption of Performance\u003cbr/\u003eInsights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eRDS uses your default KMS key. There is a default KMS key for your Amazon\u003cbr/\u003eWeb Services account. Your Amazon Web Services account has a different default\u003cbr/\u003eKMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain Performance Insights data. The default is 7\u003cbr/\u003edays. The following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 7\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * month * 31, where month is a number of months from 1-23\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, the following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 93 (3 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 341 (11 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 589 (19 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a retention period such as 94, which isn\u0026rsquo;t a valid value,\u003cbr/\u003eRDS issues an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the instances in the DB cluster accept connections.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL and Aurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL and Aurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 5432\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you are replicating a DB cluster from one Amazon Web Services GovCloud\u003cbr/\u003e(US) Region to another, an URL that contains a Signature Version 4 signed\u003cbr/\u003erequest for the CreateDBCluster operation to be called in the source Amazon\u003cbr/\u003eWeb Services Region where the DB cluster is replicated from. Specify PreSignedUrl\u003cbr/\u003eonly when you are performing cross-Region replication from an encrypted DB\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL must be a valid request for the CreateDBCluster API operation\u003cbr/\u003ethat can run in the source Amazon Web Services Region that contains the encrypted\u003cbr/\u003eDB cluster to copy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL request must contain the following parameter values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KmsKeyId - The KMS key identifier for the KMS key to use to encrypt\u003cbr/\u003e the copy of the DB cluster in the destination Amazon Web Services Region.\u003cbr/\u003e This should refer to the same KMS key for both the CreateDBCluster operation\u003cbr/\u003e that is called in the destination Amazon Web Services Region, and the\u003cbr/\u003e operation contained in the presigned URL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DestinationRegion - The name of the Amazon Web Services Region that\u003cbr/\u003e Aurora read replica will be created in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ReplicationSourceIdentifier - The DB cluster identifier for the encrypted\u003cbr/\u003e DB cluster to be copied. This identifier must be in the Amazon Resource\u003cbr/\u003e Name (ARN) format for the source Amazon Web Services Region. For example,\u003cbr/\u003e if you are copying an encrypted DB cluster from the us-west-2 Amazon Web\u003cbr/\u003e Services Region, then your ReplicationSourceIdentifier would look like\u003cbr/\u003e Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn how to generate a Signature Version 4 signed request, see Authenticating\u003cbr/\u003eRequests: Using Query Parameters (Amazon Web Services Signature Version 4)\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)\u003cbr/\u003eand Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\u003cbr/\u003eSourceRegion (or \u0026ndash;source-region for the CLI) instead of specifying PreSignedUrl\u003cbr/\u003emanually. Specifying SourceRegion autogenerates a presigned URL that is a\u003cbr/\u003evalid request for the operation that can run in the source Amazon Web Services\u003cbr/\u003eRegion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled using the BackupRetentionPeriod parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region. To view the time blocks available,\u003cbr/\u003esee Backup window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe weekly time range during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week. To see the time blocks available, see Adjusting the Preferred DB\u003cbr/\u003eCluster Maintenance Window (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster is publicly accessible.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB cluster is publicly accessible, its Domain Name System (DNS)\u003cbr/\u003eendpoint resolves to the private IP address from within the DB cluster\u0026rsquo;s\u003cbr/\u003evirtual private cloud (VPC). It resolves to the public IP address from outside\u003cbr/\u003eof the DB cluster\u0026rsquo;s VPC. Access to the DB cluster is ultimately controlled\u003cbr/\u003eby the security group it uses. That public access isn\u0026rsquo;t permitted if the\u003cbr/\u003esecurity group assigned to the DB cluster doesn\u0026rsquo;t permit it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB cluster isn\u0026rsquo;t publicly accessible, it is an internal DB cluster\u003cbr/\u003ewith a DNS name that resolves to a private IP address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default behavior varies depending on whether DBSubnetGroupName\u003cbr/\u003eis specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName isn\u0026rsquo;t specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB cluster is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region has an internet gateway attached\u003cbr/\u003e to it, the DB cluster is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName is specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB cluster is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that has an internet gateway attached\u003cbr/\u003e to it, the DB cluster is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the source DB instance or DB cluster if\u003cbr/\u003ethis DB cluster is created as a read replica.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor DB clusters in serverless DB engine mode, the scaling properties of the\u003cbr/\u003eDB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.autoPause\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.maxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.minCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.secondsBeforeTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.secondsUntilAutoPause\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalingConfiguration.timeoutAction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the scaling configuration of an Aurora Serverless v2 DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using Amazon Aurora Serverless v2 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration.maxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserverlessV2ScalingConfiguration.minCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the DB snapshot or DB cluster snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use either the name or the Amazon Resource Name (ARN) to specify\u003cbr/\u003ea DB cluster snapshot. However, you can use only the ARN to specify a DB\u003cbr/\u003esnapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing Snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB cluster is encrypted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage type to be associated with the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required to create a Multi-AZ DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: io1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen specified, a value for the Iops parameter is required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: io1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Multi-AZ DB clusters only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 VPC security groups to associate with this DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid for: Aurora DB clusters and Multi-AZ DB clusters |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactivityStreamKMSKeyID: string\nactivityStreamKinesisStreamName: string\nactivityStreamMode: string\nactivityStreamStatus: string\nassociatedRoles:\n- featureName: string\n roleARN: string\n status: string\nautomaticRestartTime: string\nbacktrackConsumedChangeRecords: integer\ncapacity: integer\ncloneGroupID: string\nclusterCreateTime: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncrossAccountClone: boolean\ncustomEndpoints:\n- string\ndbClusterMembers:\n- dbClusterParameterGroupStatus: string\n dbInstanceIdentifier: string\n isClusterWriter: boolean\n promotionTier: integer\ndbClusterOptionGroupMemberships:\n- dbClusterOptionGroupName: string\n status: string\ndbClusterParameterGroup: string\ndbClusterResourceID: string\ndbSubnetGroup: string\ndomainMemberships:\n- domain: string\n fQDN: string\n iamRoleName: string\n status: string\nearliestBacktrackTime: string\nearliestRestorableTime: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: string\nglobalWriteForwardingRequested: boolean\nglobalWriteForwardingStatus: string\nhostedZoneID: string\nhttpEndpointEnabled: boolean\niamDatabaseAuthenticationEnabled: boolean\nlatestRestorableTime: string\nmasterUserSecret: \n kmsKeyID: string\n secretARN: string\n secretStatus: string\nmultiAZ: boolean\npendingModifiedValues: \n allocatedStorage: integer\n backupRetentionPeriod: integer\n dbClusterIdentifier: string\n engineVersion: string\n iamDatabaseAuthenticationEnabled: boolean\n iops: integer\n masterUserPassword: string\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\npercentProgress: string\nperformanceInsightsEnabled: boolean\nreadReplicaIdentifiers:\n- string\nreaderEndpoint: string\nstatus: string\ntagList:\n- key: string\n value: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier used for encrypting messages in\u003cbr/\u003ethe database activity stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKinesisStreamName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon Kinesis data stream used for the database activity\u003cbr/\u003estream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of the database activity stream. Database events such as a change\u003cbr/\u003eor access generate an activity stream event. The database session can handle\u003cbr/\u003ethese events either synchronously or asynchronously.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the database activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of the Amazon Web Services Identity and Access Management\u003cbr/\u003e(IAM) roles that are associated with the DB cluster. IAM roles that are associated\u003cbr/\u003ewith a DB cluster grant permission for the DB cluster to access other Amazon\u003cbr/\u003eWeb Services on your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Amazon Web Services Identity and Access Management (IAM) role\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is associated with a DB cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticRestartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when a stopped DB cluster is restarted automatically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebacktrackConsumedChangeRecords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of change records stored for Backtrack.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current capacity of an Aurora Serverless v1 DB cluster. The capacity\u003cbr/\u003eis 0 (zero) when the cluster is paused.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Aurora Serverless v1, see Using Amazon Aurora\u003cbr/\u003eServerless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloneGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the clone group to which the DB cluster is associated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the time when the DB cluster was created, in Universal Coordinated\u003cbr/\u003eTime (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecrossAccountClone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the DB cluster is a clone of a DB cluster owned by a different\u003cbr/\u003eAmazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomEndpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eIdentifies all custom endpoints associated with the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomEndpoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about an instance that is part of a DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].isClusterWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterMembers.[].promotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of option group memberships for this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains status information for a DB cluster option group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterOptionGroupMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterParameterGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the DB cluster parameter group for the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the DB cluster.\u003cbr/\u003eThis identifier is found in Amazon Web Services CloudTrail log entries whenever\u003cbr/\u003ethe KMS key for the DB cluster is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group associated with the DB cluster,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Active Directory Domain membership records associated with the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Active Directory Domain membership record associated with the DB instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor cluster.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].fQDN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].iamRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestBacktrackTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a DB cluster can be backtracked.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eearliestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe earliest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this DB cluster is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLog types vary by DB engine. For information about the log types for each\u003cbr/\u003eDB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalWriteForwardingRequested\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether you have requested to enable write forwarding for a secondary\u003cbr/\u003ecluster in an Aurora global database. Because write forwarding takes time\u003cbr/\u003eto enable, check the value of GlobalWriteForwardingStatus to confirm that\u003cbr/\u003ethe request has completed before using the write forwarding feature for this\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalWriteForwardingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a secondary cluster in an Aurora global database has write\u003cbr/\u003eforwarding enabled, not enabled, or is in the process of enabling it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehttpEndpointEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the HTTP endpoint for an Aurora Serverless\u003cbr/\u003ev1 DB cluster is enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen enabled, the HTTP endpoint provides a connectionless web service API\u003cbr/\u003efor running SQL queries on the Aurora Serverless v1 DB cluster. You can also\u003cbr/\u003equery your database from inside the RDS console with the query editor.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using the Data API for Aurora Serverless v1 (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the secret managed by RDS in Amazon Web Services Secrets Manager\u003cbr/\u003efor the master user password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide and Password management with Amazon Web Services\u003cbr/\u003eSecrets Manager (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.secretARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecret.secretStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the DB cluster has instances in multiple Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA value that specifies that changes to the DB cluster are pending. This element\u003cbr/\u003eis only included when changes are pending. Specific changes are identified\u003cbr/\u003eby subelements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. In other words,\u003cbr/\u003ethese log types are in the process of being activated or deactivated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTrue if Performance Insights is enabled for the DB cluster, and otherwise\u003cbr/\u003efalse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is only for non-Aurora Multi-AZ DB clusters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the read replicas associated with this\u003cbr/\u003eDB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereadReplicaIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etagList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etagList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etagList.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etagList.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security groups that the DB cluster belongs to. |\n| \u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for queries on VPC security\ngroup membership. || \u003cstrong\u003evpcSecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:77,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbclusterparametergroup/",title:"DBClusterParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBClusterParameterGroup"\u003erds-controller/apis/v1alpha1#DBClusterParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBClusterParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusterparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbclusterparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB cluster parameter group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBClusterParameterGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterOverrides: {}\nparameters:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB cluster parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB cluster parameter group family name. A DB cluster parameter group\u003cbr/\u003ecan be associated with one and only one DB cluster parameter group family,\u003cbr/\u003eand can be applied only to a DB cluster running a database engine and engine\u003cbr/\u003eversion compatible with that DB cluster parameter group family.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: aurora-postgresql9.6\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mysql8.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS for PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: postgres12\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available parameter group families for a DB engine, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine \u003cengine\u003e\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to list all of the available parameter group families for the\u003cbr/\u003eAurora PostgreSQL DB engine, use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe output contains duplicates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the valid DB engine values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB cluster parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not match the name of an existing DB cluster parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is stored as a lowercase string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of parameters in the DB cluster parameter group to modify.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values (for the application method): immediate\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameters.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameters.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB cluster parameter group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameterOverrideStatuses:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of parameters for the DB cluster parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameterOverrideStatuses.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:78,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbinstance/",title:"DBInstance",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBInstance"\u003edocumentdb-controller/apis/v1alpha1#DBInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about an instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eautoMinorVersionUpgrade: boolean\navailabilityZone: string\ncaCertificateIdentifier: string\ncopyTagsToSnapshot: boolean\ndbClusterIdentifier: string\ndbInstanceClass: string\ndbInstanceIdentifier: string\nengine: string\nperformanceInsightsEnabled: boolean\nperformanceInsightsKMSKeyID: string\nperformanceInsightsKMSKeyRef: \n from: \n name: string\npreferredMaintenanceWindow: string\npromotionTier: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThis parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does\u003cbr/\u003enot perform minor version upgrades regardless of the value set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon EC2 Availability Zone that the instance is created in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: A random, system-chosen Availability Zone in the endpoint\u0026rsquo;s Amazon\u003cbr/\u003eWeb Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: us-east-1d\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecaCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe CA certificate identifier to use for the DB instance\u0026rsquo;s server certificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Updating Your Amazon DocumentDB TLS Certificates\u003cbr/\u003e(https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html)\u003cbr/\u003eand Encrypting Data in Transit (https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html)\u003cbr/\u003ein the Amazon DocumentDB Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy tags from the DB instance to snapshots\u003cbr/\u003eof the DB instance. By default, tags are not copied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the cluster that the instance will belong to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceClass\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the instance; for example, db.r5.large.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Cannot end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbinstance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid value: docdb\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable Performance Insights for the DB\u003cbr/\u003eInstance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key identifier for encryption of Performance Insights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key identifier is the key ARN, key ID, alias ARN, or alias name for\u003cbr/\u003ethe KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eDocumentDB uses your default KMS key. There is a default KMS key for your\u003cbr/\u003eAmazon Web Services account. Your Amazon Web Services account has a different\u003cbr/\u003edefault KMS key for each Amazon Web Services region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time range each week during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epromotionTier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eA value that specifies the order in which an Amazon DocumentDB replica is\u003cbr/\u003epromoted to the primary instance after a failure of the existing primary\u003cbr/\u003einstance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 0-15\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the instance. You can assign up to 10 tags to\u003cbr/\u003ean instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbackupRetentionPeriod: integer\ncertificateDetails: \n cAIdentifier: string\n validTill: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndbInstanceStatus: string\ndbSubnetGroup: \n dbSubnetGroupARN: string\n dbSubnetGroupDescription: string\n dbSubnetGroupName: string\n subnetGroupStatus: string\n subnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetStatus: string\n vpcID: string\ndbiResourceID: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: \n address: string\n hostedZoneID: string\n port: integer\nengineVersion: string\ninstanceCreateTime: string\nkmsKeyID: string\nlatestRestorableTime: string\npendingModifiedValues: \n allocatedStorage: integer\n backupRetentionPeriod: integer\n caCertificateIdentifier: string\n dbInstanceClass: string\n dbInstanceIdentifier: string\n dbSubnetGroupName: string\n engineVersion: string\n iops: integer\n licenseModel: string\n masterUserPassword: string\n multiAZ: boolean\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\n port: integer\n storageType: string\npreferredBackupWindow: string\npubliclyAccessible: boolean\nstatusInfos:\n- message: string\n normal: boolean\n status: string\n statusType: string\nstorageEncrypted: boolean\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the number of days for which automatic snapshots are retained.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the DB instance\u0026rsquo;s server certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.cAIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.validTill\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group that is associated with the instance,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.subnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroup.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbiResourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the instance.\u003cbr/\u003eThis identifier is found in CloudTrail log entries whenever the KMS key for\u003cbr/\u003ethe instance is accessed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this instance is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the database engine version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the date and time that the instance was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf StorageEncrypted is true, the KMS key identifier for the encrypted instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies that changes to the instance are pending. This element is included\u003cbr/\u003eonly when changes are pending. Specific changes are identified by subelements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.caCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.licenseModel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.multiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. These log types\u003cbr/\u003eare in the process of being activated or deactivated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.storageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the daily time range during which automated backups are created\u003cbr/\u003eif automated backups are enabled, as determined by the BackupRetentionPeriod.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eNot supported. Amazon DocumentDB does not currently support public endpoints.\u003cbr/\u003eThe value of PubliclyAccessible is always false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe status of a read replica. If the instance is not a read replica, this\u003cbr/\u003eis blank.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides a list of status information for an instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].normal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusInfos.[].statusType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether or not the instance is encrypted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security group elements that the instance belongs\u003cbr/\u003eto.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed as a response element for queries on virtual private cloud (VPC) security\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup membership.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:79,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbinstance/",title:"DBInstance",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBInstance"\u003erds-controller/apis/v1alpha1#DBInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB instance.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the operations CreateDBInstance,\nCreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance,\nPromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,\nRestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocatedStorage: integer\nautoMinorVersionUpgrade: boolean\navailabilityZone: string\nbackupRetentionPeriod: integer\nbackupTarget: string\ncaCertificateIdentifier: string\ncharacterSetName: string\ncopyTagsToSnapshot: boolean\ncustomIAMInstanceProfile: string\ndbClusterIdentifier: string\ndbClusterSnapshotIdentifier: string\ndbInstanceClass: string\ndbInstanceIdentifier: string\ndbName: string\ndbParameterGroupName: string\ndbParameterGroupRef: \n from: \n name: string\ndbSnapshotIdentifier: string\ndbSubnetGroupName: string\ndbSubnetGroupRef: \n from: \n name: string\ndeletionProtection: boolean\ndestinationRegion: string\ndomain: string\ndomainIAMRoleName: string\nenableCloudwatchLogsExports:\n- string\nenableCustomerOwnedIP: boolean\nenableIAMDatabaseAuthentication: boolean\nengine: string\nengineVersion: string\niops: integer\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nlicenseModel: string\nmanageMasterUserPassword: boolean\nmasterUserPassword: \n key: string\n name: string\n namespace: string\nmasterUserSecretKMSKeyID: string\nmasterUserSecretKMSKeyRef: \n from: \n name: string\nmasterUsername: string\nmaxAllocatedStorage: integer\nmonitoringInterval: integer\nmonitoringRoleARN: string\nmultiAZ: boolean\nncharCharacterSetName: string\nnetworkType: string\noptionGroupName: string\nperformanceInsightsEnabled: boolean\nperformanceInsightsKMSKeyID: string\nperformanceInsightsRetentionPeriod: integer\nport: integer\npreSignedURL: string\npreferredBackupWindow: string\npreferredMaintenanceWindow: string\nprocessorFeatures:\n- name: string\n value: string\npromotionTier: integer\npubliclyAccessible: boolean\nreplicaMode: string\nsourceDBInstanceIdentifier: string\nsourceRegion: string\nstorageEncrypted: boolean\nstorageThroughput: integer\nstorageType: string\ntags:\n- key: string\n value: string\ntdeCredentialARN: string\ntdeCredentialPassword: string\ntimezone: string\nuseDefaultProcessorFeatures: boolean\nvpcSecurityGroupIDs:\n- string\nvpcSecurityGroupRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of storage in gibibytes (GiB) to allocate for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Aurora cluster volumes automatically grow as the amount of\u003cbr/\u003edata in your database increases, though you are only charged for the space\u003cbr/\u003ethat you use in an Aurora cluster volume.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40\u003cbr/\u003e to 65536 for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 40 to 65536\u003cbr/\u003e for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 5 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20\u003cbr/\u003e to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Must be an integer from 10 to 3072.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints to the amount of storage for each storage type are the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * General Purpose (SSD) storage (gp2, gp3): Enterprise and Standard editions:\u003cbr/\u003e Must be an integer from 20 to 16384. Web and Express editions: Must be\u003cbr/\u003e an integer from 20 to 16384.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Provisioned IOPS storage (io1): Enterprise and Standard editions: Must\u003cbr/\u003e be an integer from 100 to 16384. Web and Express editions: Must be an\u003cbr/\u003e integer from 100 to 16384.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Magnetic storage (standard): Enterprise and Standard editions: Must\u003cbr/\u003e be an integer from 20 to 1024. Web and Express editions: Must be an integer\u003cbr/\u003e from 20 to 1024.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether minor engine upgrades are applied automatically\u003cbr/\u003eto the DB instance during the maintenance window. By default, minor engine\u003cbr/\u003eupgrades are applied automatically.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade\u003cbr/\u003eto false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Availability Zone (AZ) where the database will be created. For information\u003cbr/\u003eon Amazon Web Services Regions and Availability Zones, see Regions and Availability\u003cbr/\u003eZones (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach Aurora DB cluster hosts copies of its storage in three separate Availability\u003cbr/\u003eZones. Specify one of these Availability Zones. Aurora automatically chooses\u003cbr/\u003ean appropriate Availability Zone if you don\u0026rsquo;t specify one.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: A random, system-chosen Availability Zone in the endpoint\u0026rsquo;s Amazon\u003cbr/\u003eWeb Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: us-east-1d\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraint: The AvailabilityZone parameter can\u0026rsquo;t be specified if the DB instance\u003cbr/\u003eis a Multi-AZ deployment. The specified Availability Zone must be in the\u003cbr/\u003esame Amazon Web Services Region as the current endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which automated backups are retained. Setting this\u003cbr/\u003eparameter to a positive number enables backups. Setting this parameter to\u003cbr/\u003e0 disables automated backups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The retention period for automated backups is managed by\u003cbr/\u003ethe DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be a value from 0 to 35\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be set to 0 if the DB instance is a source to read replicas\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be set to 0 for an RDS Custom for Oracle DB instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies where automated backups and manual snapshots are stored.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are outposts (Amazon Web Services Outposts) and region (Amazon\u003cbr/\u003eWeb Services Region). The default is region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with Amazon RDS on Amazon Web Services\u003cbr/\u003eOutposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecaCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the CA certificate identifier to use for the DB instance’s server\u003cbr/\u003ecertificate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using SSL/TLS to encrypt a connection to a DB instance\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html)\u003cbr/\u003ein the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to\u003cbr/\u003ea DB cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echaracterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor supported engines, this value indicates that the DB instance should be\u003cbr/\u003eassociated with the specified CharacterSet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. However, if you need to change\u003cbr/\u003ethe character set, you can change it on the database itself.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The character set is managed by the DB cluster. For more\u003cbr/\u003einformation, see CreateDBCluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecopyTagsToSnapshot\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to copy tags from the DB instance to snapshots\u003cbr/\u003eof the DB instance. By default, tags are not copied.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting\u003cbr/\u003ethis value for an Aurora DB instance has no effect on the DB cluster setting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomIAMInstanceProfile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance profile associated with the underlying Amazon EC2 instance of\u003cbr/\u003ean RDS Custom DB instance. The instance profile must meet the following requirements:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The profile must exist in your account.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The profile must have an IAM role that Amazon EC2 has permissions to\u003cbr/\u003e assume.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The instance profile name and the associated IAM role name must start\u003cbr/\u003e with the prefix AWSRDSCustom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor the list of permissions required for the IAM role, see Configure IAM\u003cbr/\u003eand your VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is required for RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the DB cluster that the instance will belong to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbClusterSnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore\u003cbr/\u003efrom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing Multi-AZ DB cluster snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified when DBSnapshotIdentifier is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be specified when DBSnapshotIdentifier isn\u0026rsquo;t specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are restoring from a shared manual Multi-AZ DB cluster snapshot,\u003cbr/\u003e the DBClusterSnapshotIdentifier must be the ARN of the shared snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be the identifier of an Aurora DB cluster snapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster\u003cbr/\u003e snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceClass\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the DB instance, for example db.m5.large.\u003cbr/\u003eNot all DB instance classes are available in all Amazon Web Services Regions,\u003cbr/\u003eor for all database engines. For the full list of DB instance classes, and\u003cbr/\u003eavailability for your engine, see DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon RDS User Guide or Aurora DB instance classes (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB instance identifier. This parameter is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain from 1 to 63 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbinstance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe meaning of this parameter differs according to the database engine you\u003cbr/\u003euse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, no database is created in the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 64 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, no database is created in the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 64 letters or numbers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the DB instance is created. If this\u003cbr/\u003eparameter isn\u0026rsquo;t specified, a database named postgres is created in the DB\u003cbr/\u003einstance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain 1 to 63 letters, numbers, or underscores.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0-9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a word reserved by the specified database engine\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Oracle System ID (SID) of the created DB instance. If you specify null,\u003cbr/\u003ethe default value ORCL is used. You can\u0026rsquo;t specify the string NULL, or any\u003cbr/\u003eother reserved word, for DBName.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: ORCL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be longer than 8 characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for Oracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Oracle System ID (SID) of the created RDS Custom DB instance. If you\u003cbr/\u003edon\u0026rsquo;t specify a value, the default value is ORCL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: ORCL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 8 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Must be null.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Must be null.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora MySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the primary DB instance of the Aurora\u003cbr/\u003eMySQL DB cluster is created. If this parameter isn\u0026rsquo;t specified for an Aurora\u003cbr/\u003eMySQL DB cluster, no database is created in the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 64 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora PostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name of the database to create when the primary DB instance of the Aurora\u003cbr/\u003ePostgreSQL DB cluster is created. If this parameter isn\u0026rsquo;t specified for an\u003cbr/\u003eAurora PostgreSQL DB cluster, a database named postgres is created in the\u003cbr/\u003eDB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must contain 1 to 63 alphanumeric characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must begin with a letter. Subsequent characters can be letters, underscores,\u003cbr/\u003e or digits (0 to 9).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t be a word reserved by the database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB parameter group to associate with this DB instance. If\u003cbr/\u003eyou do not specify a value, then the default DB parameter group for the specified\u003cbr/\u003eDB engine and version is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It must be 1 to 255 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The first character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * It can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSnapshotIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the DB snapshot to restore from.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must match the identifier of an existing DBSnapshot.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified when DBClusterSnapshotIdentifier is specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be specified when DBClusterSnapshotIdentifier isn\u0026rsquo;t specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier\u003cbr/\u003e must be the ARN of the shared DB snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA DB subnet group to associate with this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must match the name of an existing DBSubnetGroup. Must not be\u003cbr/\u003edefault.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance has deletion protection enabled.\u003cbr/\u003eThe database can\u0026rsquo;t be deleted when deletion protection is enabled. By default,\u003cbr/\u003edeletion protection isn\u0026rsquo;t enabled. For more information, see Deleting a DB\u003cbr/\u003eInstance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. You can enable or disable deletion protection for the DB\u003cbr/\u003ecluster. For more information, see CreateDBCluster. DB instances in a DB\u003cbr/\u003ecluster can be deleted even when deletion protection is enabled for the DB\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDestinationRegion is used for presigning the request to a given region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Active Directory directory ID to create the DB instance in. Currently,\u003cbr/\u003eonly MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can\u003cbr/\u003ebe created in an Active Directory Domain.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Kerberos Authentication (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The domain is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainIAMRoleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the name of the IAM role to be used when making API calls to the\u003cbr/\u003eDirectory Service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The domain is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of log types that need to be enabled for exporting to CloudWatch\u003cbr/\u003eLogs. The values in the list depend on the DB engine. For more information,\u003cbr/\u003esee Publishing Database Logs to Amazon CloudWatch Logs (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. CloudWatch Logs exports are managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are agent and error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are audit, error, general, and slowquery.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are alert, audit, listener, trace, and oemagent.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePossible values are postgresql and upgrade.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableIAMDatabaseAuthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable mapping of Amazon Web Services Identity\u003cbr/\u003eand Access Management (IAM) accounts to database accounts. By default, mapping\u003cbr/\u003eisn\u0026rsquo;t enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see IAM Database Authentication for MySQL and PostgreSQL\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Mapping Amazon Web Services IAM accounts to database accounts\u003cbr/\u003eis managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot every database engine is available for every Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-oracle-ee (for RDS Custom for Oracle instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-ee (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-se (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-sqlserver-web (for RDS Custom for SQL Server instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mariadb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-se\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ex\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-web\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the database engine to use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of valid engine versions, use the DescribeDBEngineVersions operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the database engines and links to information about the\u003cbr/\u003emajor and minor versions that are available with Amazon RDS. Not every database\u003cbr/\u003eengine is available for every Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The version number of the database engine to be used by the\u003cbr/\u003eDB instance is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for Oracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA custom engine version (CEV) that you have previously created. This setting\u003cbr/\u003eis required for RDS Custom for Oracle. The CEV name has the following format:\u003cbr/\u003e19.customized_string. A valid CEV name is 19.my_cev1. For more information,\u003cbr/\u003esee Creating an RDS Custom for Oracle DB instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-creating.html#custom-creating.create)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom for SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSee RDS Custom for SQL Server general requirements (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-reqs-limits-MS.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see MariaDB on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Microsoft SQL Server Versions on Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see MySQL on Amazon RDS Versions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Oracle Database Engine Release Notes (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information, see Amazon RDS for PostgreSQL versions and extensions (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of Provisioned IOPS (input/output operations per second) to be\u003cbr/\u003einitially allocated for the DB instance. For information about valid IOPS\u003cbr/\u003evalues, see Amazon RDS DB instance storage (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must\u003cbr/\u003ebe a multiple between .5 and 50 of the storage amount for the DB instance.\u003cbr/\u003eFor SQL Server DB instances, must be a multiple between 1 and 50 of the storage\u003cbr/\u003eamount for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for an encrypted DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The Amazon Web Services KMS key identifier is managed by\u003cbr/\u003ethe DB cluster. For more information, see CreateDBCluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId\u003cbr/\u003eparameter, then Amazon RDS uses your default KMS key. There is a default\u003cbr/\u003eKMS key for your Amazon Web Services account. Your Amazon Web Services account\u003cbr/\u003ehas a different default KMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS Custom\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA KMS key is required for RDS Custom instances. For most RDS engines, if\u003cbr/\u003eyou leave this parameter empty while enabling StorageEncrypted, the engine\u003cbr/\u003euses the default KMS key. However, RDS Custom doesn\u0026rsquo;t use the default key\u003cbr/\u003ewhen this parameter is empty. You must explicitly specify a key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseModel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLicense model information for this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: license-included\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanageMasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to manage the master user password with Amazon\u003cbr/\u003eWeb Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t manage the master user password with Amazon Web Services Secrets\u003cbr/\u003e Manager if MasterUserPassword is specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe password for the master user. The password can include any printable\u003cbr/\u003eASCII character except \u0026ldquo;/\u0026rdquo;, \u0026ldquo;\u0026quot;\u0026rdquo;, or \u0026ldquo;@\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The password for the master user is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Can\u0026rsquo;t be specified if ManageMasterUserPassword is turned on.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMicrosoft SQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 128 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 41 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 30 characters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain from 8 to 128 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier to encrypt a secret that is automatically\u003cbr/\u003egenerated and managed in Amazon Web Services Secrets Manager.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting is valid only if the master user password is managed by RDS\u003cbr/\u003ein Amazon Web Services Secrets Manager for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key. To use a KMS key in a different Amazon\u003cbr/\u003eWeb Services account, specify the key ARN or alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager\u003cbr/\u003eKMS key is used to encrypt the secret. If the secret is in a different Amazon\u003cbr/\u003eWeb Services account, then you can\u0026rsquo;t use the aws/secretsmanager KMS key to\u003cbr/\u003eencrypt the secret, and you must use a customer managed KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is a default KMS key for your Amazon Web Services account. Your Amazon\u003cbr/\u003eWeb Services account has a different default KMS key for each Amazon Web\u003cbr/\u003eServices Region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUserSecretKMSKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterUsername\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the master user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The name for the master user is managed by the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon RDS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 16 letters, numbers, or underscores.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be a reserved word for the chosen database engine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxAllocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe upper limit in gibibytes (GiB) to which Amazon RDS can automatically\u003cbr/\u003escale the storage of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about this setting, including limitations that apply\u003cbr/\u003eto it, see Managing capacity automatically with Amazon RDS storage autoscaling\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe interval, in seconds, between points when Enhanced Monitoring metrics\u003cbr/\u003eare collected for the DB instance. To disable collection of Enhanced Monitoring\u003cbr/\u003emetrics, specify 0. The default is 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringRoleArn is specified, then you must set MonitoringInterval to\u003cbr/\u003ea value other than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0, 1, 5, 10, 15, 30, 60\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN for the IAM role that permits RDS to send enhanced monitoring metrics\u003cbr/\u003eto Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.\u003cbr/\u003eFor information on creating a monitoring role, see Setting Up and Enabling\u003cbr/\u003eEnhanced Monitoring (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf MonitoringInterval is set to a value other than 0, then you must supply\u003cbr/\u003ea MonitoringRoleArn value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is a Multi-AZ deployment.\u003cbr/\u003eYou can\u0026rsquo;t set the AvailabilityZone parameter if the DB instance is a Multi-AZ\u003cbr/\u003edeployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. DB instance Availability Zones (AZs) are managed by the DB\u003cbr/\u003ecluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003encharCharacterSetName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the NCHAR character set for the Oracle DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe network type is determined by the DBSubnetGroup specified for the DB\u003cbr/\u003einstance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4\u003cbr/\u003eand the IPv6 protocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA value that indicates that the DB instance should be associated with the\u003cbr/\u003especified option group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePermanent options, such as the TDE option for Oracle Advanced Security TDE,\u003cbr/\u003ecan\u0026rsquo;t be removed from an option group. Also, that option group can\u0026rsquo;t be removed\u003cbr/\u003efrom a DB instance after it is associated with a DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether to enable Performance Insights for the DB\u003cbr/\u003einstance. For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier for encryption of Performance\u003cbr/\u003eInsights data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias\u003cbr/\u003eARN, or alias name for the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon\u003cbr/\u003eRDS uses your default KMS key. There is a default KMS key for your Amazon\u003cbr/\u003eWeb Services account. Your Amazon Web Services account has a different default\u003cbr/\u003eKMS key for each Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eperformanceInsightsRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days to retain Performance Insights data. The default is 7\u003cbr/\u003edays. The following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 7\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * month * 31, where month is a number of months from 1-23\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, the following values are valid:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 93 (3 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 341 (11 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 589 (19 months * 31)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 731\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a retention period such as 94, which isn\u0026rsquo;t a valid value,\u003cbr/\u003eRDS issues an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which the database accepts connections.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMySQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMariaDB\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePostgreSQL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 5432\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOracle\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1521\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSQL Server\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1433\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and\u003cbr/\u003e49152-49156.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 3306\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: 1150-65535\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eType: Integer\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreSignedURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you are creating a read replica from one Amazon Web Services GovCloud\u003cbr/\u003e(US) Region to another or from one China Amazon Web Services Region to another,\u003cbr/\u003ethe URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica\u003cbr/\u003eAPI operation in the source Amazon Web Services Region that contains the\u003cbr/\u003esource DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only to Amazon Web Services GovCloud (US) Regions and\u003cbr/\u003eChina Amazon Web Services Regions. It\u0026rsquo;s ignored in other Amazon Web Services\u003cbr/\u003eRegions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only when replicating from a source DB instance. Source\u003cbr/\u003eDB clusters aren\u0026rsquo;t supported in Amazon Web Services GovCloud (US) Regions\u003cbr/\u003eand China Amazon Web Services Regions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must specify this parameter when you create an encrypted read replica\u003cbr/\u003efrom another Amazon Web Services Region by using the Amazon RDS API. Don\u0026rsquo;t\u003cbr/\u003especify PreSignedUrl when you are creating an encrypted read replica in the\u003cbr/\u003esame Amazon Web Services Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe presigned URL must be a valid request for the CreateDBInstanceReadReplica\u003cbr/\u003eAPI operation that can run in the source Amazon Web Services Region that\u003cbr/\u003econtains the encrypted source DB instance. The presigned URL request must\u003cbr/\u003econtain the following parameter values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DestinationRegion - The Amazon Web Services Region that the encrypted\u003cbr/\u003e read replica is created in. This Amazon Web Services Region is the same\u003cbr/\u003e one where the CreateDBInstanceReadReplica operation is called that contains\u003cbr/\u003e this presigned URL. For example, if you create an encrypted DB instance\u003cbr/\u003e in the us-west-1 Amazon Web Services Region, from a source DB instance\u003cbr/\u003e in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica\u003cbr/\u003e operation in the us-east-1 Amazon Web Services Region and provide a presigned\u003cbr/\u003e URL that contains a call to the CreateDBInstanceReadReplica operation\u003cbr/\u003e in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion\u003cbr/\u003e in the presigned URL must be set to the us-east-1 Amazon Web Services\u003cbr/\u003e Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KmsKeyId - The KMS key identifier for the key to use to encrypt the\u003cbr/\u003e read replica in the destination Amazon Web Services Region. This is the\u003cbr/\u003e same identifier for both the CreateDBInstanceReadReplica operation that\u003cbr/\u003e is called in the destination Amazon Web Services Region, and the operation\u003cbr/\u003e contained in the presigned URL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SourceDBInstanceIdentifier - The DB instance identifier for the encrypted\u003cbr/\u003e DB instance to be replicated. This identifier must be in the Amazon Resource\u003cbr/\u003e Name (ARN) format for the source Amazon Web Services Region. For example,\u003cbr/\u003e if you are creating an encrypted read replica from a DB instance in the\u003cbr/\u003e us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier\u003cbr/\u003e looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn how to generate a Signature Version 4 signed request, see Authenticating\u003cbr/\u003eRequests: Using Query Parameters (Amazon Web Services Signature Version 4)\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html)\u003cbr/\u003eand Signature Version 4 Signing Process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using an Amazon Web Services SDK tool or the CLI, you can specify\u003cbr/\u003eSourceRegion (or \u0026ndash;source-region for the CLI) instead of specifying PreSignedUrl\u003cbr/\u003emanually. Specifying SourceRegion autogenerates a presigned URL that is a\u003cbr/\u003evalid request for the operation that can run in the source Amazon Web Services\u003cbr/\u003eRegion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSourceRegion isn\u0026rsquo;t supported for SQL Server, because Amazon RDS for SQL Server\u003cbr/\u003edoesn\u0026rsquo;t support cross-Region read replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredBackupWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which automated backups are created if automated\u003cbr/\u003ebackups are enabled, using the BackupRetentionPeriod parameter. The default\u003cbr/\u003eis a 30-minute window selected at random from an 8-hour block of time for\u003cbr/\u003eeach Amazon Web Services Region. For more information, see Backup window\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The daily time range for creating automated backups is managed\u003cbr/\u003eby the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in the format hh24:mi-hh24:mi.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be in Universal Coordinated Time (UTC).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not conflict with the preferred maintenance window.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be at least 30 minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time range each week during which system maintenance can occur, in Universal\u003cbr/\u003eCoordinated Time (UTC). For more information, see Amazon RDS Maintenance\u003cbr/\u003eWindow (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFormat: ddd:hh24:mi-ddd:hh24:mi\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is a 30-minute window selected at random from an 8-hour block\u003cbr/\u003eof time for each Amazon Web Services Region, occurring on a random day of\u003cbr/\u003ethe week.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Minimum 30-minute window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe number of CPU cores and the number of threads per core for the DB instance\u003cbr/\u003eclass of the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessorFeatures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the processor features of a DB instance class.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eTo specify the number of CPU cores, use the coreCount feature name for the\nName parameter. To specify the number of threads per core, use the threadsPerCore\nfeature name for the Name parameter.\u003c/p\u003e\n\u003cp\u003eYou can set the processor features of the DB instance class for a DB instance\nwhen you call one of the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromS3\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceToPointInTime\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou can view the valid processor values for a particular instance class by\ncalling the DescribeOrderableDBInstanceOptions action and specifying the\ninstance class for the DBInstanceClass parameter.\u003c/p\u003e\n\u003cp\u003eIn addition, you can use the following actions for DB instance class processor\ninformation:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBInstances\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBSnapshots\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeValidDBInstanceModifications\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you call DescribeDBInstances, ProcessorFeature returns non-null values\nonly if the following conditions are met:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eYou are accessing an Oracle DB instance.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eYour Oracle DB instance class supports configuring the number of CPU\ncores and threads per core.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe current number CPU cores and threads is set to a non-default value.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Configuring the Processor of the DB Instance Class\n(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)\nin the Amazon RDS User Guide. || \u003cstrong\u003eprocessorFeatures.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprocessorFeatures.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003epromotionTier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eA value that specifies the order in which an Aurora Replica is promoted to\u003cbr/\u003ethe primary instance after a failure of the existing primary instance. For\u003cbr/\u003emore information, see Fault Tolerance for an Aurora DB Cluster (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance)\u003cbr/\u003ein the Amazon Aurora User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 1\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: 0 - 15 |\n| \u003cstrong\u003epubliclyAccessible\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is publicly accessible.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB instance is publicly accessible, its Domain Name System (DNS)\u003cbr/\u003eendpoint resolves to the private IP address from within the DB instance\u0026rsquo;s\u003cbr/\u003evirtual private cloud (VPC). It resolves to the public IP address from outside\u003cbr/\u003eof the DB instance\u0026rsquo;s VPC. Access to the DB instance is ultimately controlled\u003cbr/\u003eby the security group it uses. That public access is not permitted if the\u003cbr/\u003esecurity group assigned to the DB instance doesn\u0026rsquo;t permit it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the DB instance isn\u0026rsquo;t publicly accessible, it is an internal DB instance\u003cbr/\u003ewith a DNS name that resolves to a private IP address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default behavior varies depending on whether DBSubnetGroupName\u003cbr/\u003eis specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName isn\u0026rsquo;t specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB instance is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the default VPC in the target Region has an internet gateway attached\u003cbr/\u003e to it, the DB instance is public.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf DBSubnetGroupName is specified, and PubliclyAccessible isn\u0026rsquo;t specified,\u003cbr/\u003ethe following applies:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that doesn’t have an internet gateway\u003cbr/\u003e attached to it, the DB instance is private.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the subnets are part of a VPC that has an internet gateway attached\u003cbr/\u003e to it, the DB instance is public. |\n| \u003cstrong\u003ereplicaMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe open mode of the replica database: mounted or read-only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for Oracle DB instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMounted DB replicas are included in Oracle Database Enterprise Edition. The\u003cbr/\u003emain use case for mounted replicas is cross-Region disaster recovery. The\u003cbr/\u003eprimary database doesn\u0026rsquo;t use Active Data Guard to transmit information to\u003cbr/\u003ethe mounted replica. Because it doesn\u0026rsquo;t accept user connections, a mounted\u003cbr/\u003ereplica can\u0026rsquo;t serve a read-only workload.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create a combination of mounted and read-only DB replicas for the\u003cbr/\u003esame primary DB instance. For more information, see Working with Oracle Read\u003cbr/\u003eReplicas for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RDS Custom, you must specify this parameter and set it to mounted. The\u003cbr/\u003evalue won\u0026rsquo;t be set by default. After replica creation, you can manage the\u003cbr/\u003eopen mode manually. |\n| \u003cstrong\u003esourceDBInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the DB instance that will act as the source for the read\u003cbr/\u003ereplica. Each DB instance can have up to 15 read replicas, with the exception\u003cbr/\u003eof Oracle and SQL Server, which can have up to five.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL,\u003cbr/\u003e or SQL Server DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t be specified if the SourceDBClusterIdentifier parameter is also\u003cbr/\u003e specified.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the limitations of Oracle read replicas, see Version and licensing\u003cbr/\u003e considerations for RDS for Oracle replicas (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses)\u003cbr/\u003e in the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the limitations of SQL Server read replicas, see Read replica limitations\u003cbr/\u003e with SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations)\u003cbr/\u003e in the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The specified DB instance must have automatic backups enabled, that\u003cbr/\u003e is, its backup retention period must be greater than 0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the source DB instance is in the same Amazon Web Services Region\u003cbr/\u003e as the read replica, specify a valid DB instance identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If the source DB instance is in a different Amazon Web Services Region\u003cbr/\u003e from the read replica, specify a valid DB instance ARN. For more information,\u003cbr/\u003e see Constructing an ARN for Amazon RDS (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing)\u003cbr/\u003e in the Amazon RDS User Guide. This doesn\u0026rsquo;t apply to SQL Server or RDS\u003cbr/\u003e Custom, which don\u0026rsquo;t support cross-Region replicas. |\n| \u003cstrong\u003esourceRegion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSourceRegion is the source region where the resource exists. This is not\u003cbr/\u003esent over the wire and is only used for presigning. This value should always\u003cbr/\u003ehave the same region as the source ARN. |\n| \u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance is encrypted. By default,\u003cbr/\u003eit isn\u0026rsquo;t encrypted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RDS Custom instances, either set this parameter to true or leave it unset.\u003cbr/\u003eIf you set this parameter to false, RDS reports an error.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The encryption for DB instances is managed by the DB cluster. |\n| \u003cstrong\u003estorageThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage throughput value for the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting applies only to the gp3 storage type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom or Amazon Aurora. |\n| \u003cstrong\u003estorageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the storage type to be associated with the DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values: gp2 | gp3 | io1 | standard\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify io1 or gp3, you must also include a value for the Iops parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: io1 if the Iops parameter is specified, otherwise gp2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. Storage is managed by the DB cluster. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB instance. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etdeCredentialARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN from the key store with which to associate the instance for TDE encryption.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. |\n| \u003cstrong\u003etdeCredentialPassword\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe password for the given ARN from the key store in order to access the\u003cbr/\u003edevice.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. |\n| \u003cstrong\u003etimezone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time zone of the DB instance. The time zone parameter is currently supported\u003cbr/\u003eonly by Microsoft SQL Server (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). |\n| \u003cstrong\u003euseDefaultProcessorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA value that indicates whether the DB instance class of the DB instance uses\u003cbr/\u003eits default processor features.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis setting doesn\u0026rsquo;t apply to RDS Custom. |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon EC2 VPC security groups to associate with this DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Aurora\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNot applicable. The associated list of EC2 VPC security groups is managed\u003cbr/\u003eby the DB cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The default EC2 VPC security group for the DB subnet group\u0026rsquo;s VPC. |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactivityStreamEngineNativeAuditFieldsIncluded: boolean\nactivityStreamKMSKeyID: string\nactivityStreamKinesisStreamName: string\nactivityStreamMode: string\nactivityStreamPolicyStatus: string\nactivityStreamStatus: string\nassociatedRoles:\n- featureName: string\n roleARN: string\n status: string\nautomaticRestartTime: string\nautomationMode: string\nawsBackupRecoveryPointARN: string\ncertificateDetails: \n cAIdentifier: string\n validTill: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncustomerOwnedIPEnabled: boolean\ndbInstanceAutomatedBackupsReplications:\n- dbInstanceAutomatedBackupsARN: string\ndbInstancePort: integer\ndbInstanceStatus: string\ndbParameterGroups:\n- dbParameterGroupName: string\n parameterApplyStatus: string\ndbSubnetGroup: \n dbSubnetGroupARN: string\n dbSubnetGroupDescription: string\n dbSubnetGroupName: string\n subnetGroupStatus: string\n subnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n arn: string\n subnetStatus: string\n supportedNetworkTypes:\n - string\n vpcID: string\ndbSystemID: string\ndbiResourceID: string\ndomainMemberships:\n- domain: string\n fQDN: string\n iamRoleName: string\n status: string\nenabledCloudwatchLogsExports:\n- string\nendpoint: \n address: string\n hostedZoneID: string\n port: integer\nenhancedMonitoringResourceARN: string\niamDatabaseAuthenticationEnabled: boolean\ninstanceCreateTime: string\nlatestRestorableTime: string\nlistenerEndpoint: \n address: string\n hostedZoneID: string\n port: integer\nmasterUserSecret: \n kmsKeyID: string\n secretARN: string\n secretStatus: string\noptionGroupMemberships:\n- optionGroupName: string\n status: string\npendingModifiedValues: \n allocatedStorage: integer\n automationMode: string\n backupRetentionPeriod: integer\n caCertificateIdentifier: string\n dbInstanceClass: string\n dbInstanceIdentifier: string\n dbSubnetGroupName: string\n engineVersion: string\n iamDatabaseAuthenticationEnabled: boolean\n iops: integer\n licenseModel: string\n masterUserPassword: string\n multiAZ: boolean\n pendingCloudwatchLogsExports: \n logTypesToDisable:\n - string\n logTypesToEnable:\n - string\n port: integer\n processorFeatures:\n - name: string\n value: string\n resumeFullAutomationModeTime: string\n storageThroughput: integer\n storageType: string\nreadReplicaDBClusterIdentifiers:\n- string\nreadReplicaDBInstanceIdentifiers:\n- string\nreadReplicaSourceDBClusterIdentifier: string\nreadReplicaSourceDBInstanceIdentifier: string\nresumeFullAutomationModeTime: string\nsecondaryAvailabilityZone: string\nstatusInfos:\n- message: string\n normal: boolean\n status: string\n statusType: string\nvpcSecurityGroups:\n- status: string\n vpcSecurityGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamEngineNativeAuditFieldsIncluded\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether engine-native audit fields are included in the database\u003cbr/\u003eactivity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services KMS key identifier used for encrypting messages in\u003cbr/\u003ethe database activity stream. The Amazon Web Services KMS key identifier\u003cbr/\u003eis the key ARN, key ID, alias ARN, or alias name for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamKinesisStreamName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon Kinesis data stream used for the database activity\u003cbr/\u003estream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of the database activity stream. Database events such as a change\u003cbr/\u003eor access generate an activity stream event. RDS for Oracle always handles\u003cbr/\u003ethese events asynchronously.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamPolicyStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the policy state of the activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactivityStreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the database activity stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Identity and Access Management (IAM) roles associated\u003cbr/\u003ewith the DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an Amazon Web Services Identity and Access Management (IAM) role\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is associated with a DB instance.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociatedRoles.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticRestartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when a stopped DB instance is restarted automatically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomationMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe automation mode of the RDS Custom DB instance: full or all paused. If\u003cbr/\u003efull, the DB instance automates monitoring and instance recovery. If all\u003cbr/\u003epaused, the instance pauses automation for the duration set by \u0026ndash;resume-full-automation-mode-minutes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eawsBackupRecoveryPointARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the recovery point in Amazon Web Services\u003cbr/\u003eBackup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of the DB instance\u0026rsquo;s server certificate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.cAIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertificateDetails.validTill\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a customer-owned IP address (CoIP) is enabled for an RDS\u003cbr/\u003eon Outposts DB instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA CoIP provides local or external connectivity to resources in your Outpost\u003cbr/\u003esubnets through your on-premises network. For some use cases, a CoIP can\u003cbr/\u003eprovide lower latency for connections to the DB instance from outside of\u003cbr/\u003eits virtual private cloud (VPC) on your local network.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Working with Amazon RDS on\u003cbr/\u003eAmazon Web Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CoIPs, see Customer-owned IP addresses (https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing)\u003cbr/\u003ein the Amazon Web Services Outposts User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceAutomatedBackupsReplications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of replicated automated backups associated with the DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceAutomatedBackupsReplications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAutomated backups of a DB instance replicated to another Amazon Web Services\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eRegion. They consist of system backups, transaction logs, and database instance\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eproperties.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstancePort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eSpecifies the port that the DB instance listens on. If the DB instance is\u003cbr/\u003epart of a DB cluster, this can be a different port than the DB cluster port.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this database.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about DB instance statuses, see Viewing DB instance status\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/accessing-monitoring.html#Overview.DBInstance.Status)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of DB parameter groups applied to this DB instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edbParameterGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstanceReadReplica\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDeleteDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRebootDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot || \u003cstrong\u003edbParameterGroups.[].dbParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbParameterGroups.[].parameterApplyStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies information on the subnet group associated with the DB instance,\u003cbr/\u003eincluding the name, description, and subnets in the subnet group. |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for the DescribeDBSubnetGroups\noperation. || \u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains Availability Zone information.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis data type is used as an element in the OrderableDBInstanceOption data\u003cbr/\u003etype. |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data type that represents an Outpost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Amazon RDS on Amazon Web\u003cbr/\u003eServices Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetOutpost.arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.subnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.supportedNetworkTypes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSubnetGroup.supportedNetworkTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edbSubnetGroup.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edbSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Oracle system ID (Oracle SID) for a container database (CDB). The Oracle\u003cbr/\u003eSID is also the name of the CDB. This setting is valid for RDS Custom only. |\n| \u003cstrong\u003edbiResourceID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services Region-unique, immutable identifier for the DB instance.\u003cbr/\u003eThis identifier is found in Amazon Web Services CloudTrail log entries whenever\u003cbr/\u003ethe Amazon Web Services KMS key for the DB instance is accessed. |\n| \u003cstrong\u003edomainMemberships\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Active Directory Domain membership records associated with the DB instance. |\n| \u003cstrong\u003edomainMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Active Directory Domain membership record associated with the DB instance\nor cluster. || \u003cstrong\u003edomainMemberships.[].domain\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].fQDN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].iamRoleName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edomainMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eenabledCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of log types that this DB instance is configured to export to CloudWatch\u003cbr/\u003eLogs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLog types vary by DB engine. For information about the log types for each\u003cbr/\u003eDB engine, see Amazon RDS Database Log Files (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003eenabledCloudwatchLogsExports.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the connection endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe endpoint might not be shown for instances whose status is creating. |\n| \u003cstrong\u003eendpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eendpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eendpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eenhancedMonitoringResourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that\u003cbr/\u003ereceives the Enhanced Monitoring metrics data for the DB instance. |\n| \u003cstrong\u003eiamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTrue if mapping of Amazon Web Services Identity and Access Management (IAM)\u003cbr/\u003eaccounts to database accounts is enabled, and otherwise false.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM database authentication can be enabled for the following database engines\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For MySQL 5.6, minor version 5.6.34 or higher\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For MySQL 5.7, minor version 5.7.16 or higher\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora 5.6 or higher. To enable IAM database authentication for Aurora,\u003cbr/\u003e see DBCluster Type. |\n| \u003cstrong\u003einstanceCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the date and time the DB instance was created. |\n| \u003cstrong\u003elatestRestorableTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the latest time to which a database can be restored with point-in-time\u003cbr/\u003erestore. |\n| \u003cstrong\u003elistenerEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the listener connection endpoint for SQL Server Always On. |\n| \u003cstrong\u003elistenerEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elistenerEndpoint.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elistenerEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the secret managed by RDS in Amazon Web Services Secrets Manager\u003cbr/\u003efor the master user password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Password management with Amazon Web Services Secrets\u003cbr/\u003eManager (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html)\u003cbr/\u003ein the Amazon RDS User Guide. |\n| \u003cstrong\u003emasterUserSecret.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret.secretARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emasterUserSecret.secretStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eoptionGroupMemberships\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides the list of option group memberships for this DB instance. |\n| \u003cstrong\u003eoptionGroupMemberships.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides information on the option groups the DB instance is a member of. || \u003cstrong\u003eoptionGroupMemberships.[].optionGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eoptionGroupMemberships.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA value that specifies that changes to the DB instance are pending. This\u003cbr/\u003eelement is only included when changes are pending. Specific changes are identified\u003cbr/\u003eby subelements. |\n| \u003cstrong\u003ependingModifiedValues.allocatedStorage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.automationMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.backupRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.caCertificateIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbInstanceClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.dbSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.iamDatabaseAuthenticationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.licenseModel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.multiAZ\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the log types whose configuration is still pending. In other words,\u003cbr/\u003ethese log types are in the process of being activated or deactivated. |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ependingModifiedValues.port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the processor features of a DB instance class.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eTo specify the number of CPU cores, use the coreCount feature name for the\nName parameter. To specify the number of threads per core, use the threadsPerCore\nfeature name for the Name parameter.\u003c/p\u003e\n\u003cp\u003eYou can set the processor features of the DB instance class for a DB instance\nwhen you call one of the following actions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eModifyDBInstance\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromDBSnapshot\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceFromS3\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eRestoreDBInstanceToPointInTime\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou can view the valid processor values for a particular instance class by\ncalling the DescribeOrderableDBInstanceOptions action and specifying the\ninstance class for the DBInstanceClass parameter.\u003c/p\u003e\n\u003cp\u003eIn addition, you can use the following actions for DB instance class processor\ninformation:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBInstances\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeDBSnapshots\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDescribeValidDBInstanceModifications\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you call DescribeDBInstances, ProcessorFeature returns non-null values\nonly if the following conditions are met:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eYou are accessing an Oracle DB instance.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eYour Oracle DB instance class supports configuring the number of CPU\ncores and threads per core.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe current number CPU cores and threads is set to a non-default value.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Configuring the Processor of the DB Instance Class\n(https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor)\nin the Amazon RDS User Guide. || \u003cstrong\u003ependingModifiedValues.processorFeatures.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.processorFeatures.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.resumeFullAutomationModeTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.storageThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingModifiedValues.storageType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereadReplicaDBClusterIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of Aurora DB clusters to which the RDS DB\u003cbr/\u003einstance is replicated as a read replica. For example, when you create an\u003cbr/\u003eAurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB\u003cbr/\u003ecluster for the Aurora read replica is shown. This output doesn\u0026rsquo;t contain\u003cbr/\u003einformation about cross-Region Aurora read replicas.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCurrently, each RDS DB instance can have only one Aurora read replica. |\n| \u003cstrong\u003ereadReplicaDBClusterIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ereadReplicaDBInstanceIdentifiers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains one or more identifiers of the read replicas associated with this\u003cbr/\u003eDB instance. |\n| \u003cstrong\u003ereadReplicaDBInstanceIdentifiers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003ereadReplicaSourceDBClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source DB cluster if this DB instance is a\u003cbr/\u003eread replica. |\n| \u003cstrong\u003ereadReplicaSourceDBInstanceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eContains the identifier of the source DB instance if this DB instance is\u003cbr/\u003ea read replica. |\n| \u003cstrong\u003eresumeFullAutomationModeTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe number of minutes to pause the automation. When the time period ends,\u003cbr/\u003eRDS Custom resumes full automation. The minimum value is 60 (default). The\u003cbr/\u003emaximum value is 1,440. |\n| \u003cstrong\u003esecondaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf present, specifies the name of the secondary Availability Zone for a DB\u003cbr/\u003einstance with multi-AZ support. |\n| \u003cstrong\u003estatusInfos\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe status of a read replica. If the instance isn\u0026rsquo;t a read replica, this\u003cbr/\u003eis blank. |\n| \u003cstrong\u003estatusInfos.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides a list of status information for a DB instance. || \u003cstrong\u003estatusInfos.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].normal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estatusInfos.[].statusType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of VPC security group elements that the DB instance belongs\u003cbr/\u003eto. |\n| \u003cstrong\u003evpcSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for queries on VPC security\ngroup membership. || \u003cstrong\u003evpcSecurityGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroups.[].vpcSecurityGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:80,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbparametergroup/",title:"DBParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBParameterGroup"\u003erds-controller/apis/v1alpha1#DBParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB parameter group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBParameterGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterOverrides: {}\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe DB parameter group family name. A DB parameter group can be associated\u003cbr/\u003ewith one and only one DB parameter group family, and can be applied only\u003cbr/\u003eto a DB instance running a database engine and engine version compatible\u003cbr/\u003ewith that DB parameter group family.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo list all of the available parameter group families for a DB engine, use\u003cbr/\u003ethe following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine \u003cengine\u003e\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to list all of the available parameter group families for the\u003cbr/\u003eMySQL DB engine, use the following command:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eaws rds describe-db-engine-versions \u0026ndash;query \u0026ldquo;DBEngineVersions[].DBParameterGroupFamily\u0026rdquo;\u003cbr/\u003e\u0026ndash;engine mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe output contains duplicates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are the valid DB engine values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora (for MySQL 5.6-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * aurora-postgresql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mariadb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * mysql\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-ee-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * oracle-se2-cdb\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * postgres\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ee\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-se\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-ex\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqlserver-web\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the DB parameter group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must be 1 to 255 letters, numbers, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can\u0026rsquo;t end with a hyphen or contain two consecutive hyphens\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is stored as a lowercase string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameterOverrideStatuses:\n- allowedValues: string\n applyMethod: string\n applyType: string\n dataType: string\n description: string\n isModifiable: boolean\n minimumEngineVersion: string\n parameterName: string\n parameterValue: string\n source: string\n supportedEngineModes:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Parameter values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterOverrideStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a request parameter in the ModifyDBParameterGroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand ResetDBParameterGroup actions.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeEngineDefaultParameters\nand DescribeDBParameters actions. || \u003cstrong\u003eparameterOverrideStatuses.[].allowedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].applyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].isModifiable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].source\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eparameterOverrideStatuses.[].supportedEngineModes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:81,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbproxy/",title:"DBProxy",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBProxy"\u003erds-controller/apis/v1alpha1#DBProxy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBProxy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBProxyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbproxies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbproxy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe data structure representing a proxy managed by the RDS Proxy.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBProxies action.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauth:\n- authScheme: string\n clientPasswordAuthType: string\n description: string\n iamAuth: string\n secretARN: string\n userName: string\ndebugLogging: boolean\nengineFamily: string\nidleClientTimeout: integer\nname: string\nrequireTLS: boolean\nroleARN: string\ntags:\n- key: string\n value: string\nvpcSecurityGroupIDs:\n- string\nvpcSubnetIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe authorization mechanism that the proxy uses.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the details of authentication used by a proxy to log in as a specific\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edatabase user.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].clientPasswordAuthType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].iamAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].secretARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauth.[].userName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugLogging\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhether the proxy includes detailed information about SQL statements in its\u003cbr/\u003elogs. This information helps you to debug issues involving SQL behavior or\u003cbr/\u003ethe performance and scalability of the proxy connections. The debug information\u003cbr/\u003eincludes the text of SQL statements that you submit through the proxy. Thus,\u003cbr/\u003eonly enable this setting when needed for debugging, and only when you have\u003cbr/\u003esecurity measures in place to safeguard any sensitive information that appears\u003cbr/\u003ein the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineFamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe kinds of databases that the proxy can connect to. This value determines\u003cbr/\u003ewhich database network protocol the proxy recognizes when it interprets network\u003cbr/\u003etraffic to and from the database. For Aurora MySQL, RDS for MariaDB, and\u003cbr/\u003eRDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for\u003cbr/\u003ePostgreSQL databases, specify POSTGRESQL. For RDS for Microsoft SQL Server,\u003cbr/\u003especify SQLSERVER.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eidleClientTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of seconds that a connection to the proxy can be inactive before\u003cbr/\u003ethe proxy disconnects it. You can set this value higher or lower than the\u003cbr/\u003econnection timeout limit for the associated database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the proxy. This name must be unique for all proxies owned\u003cbr/\u003eby your Amazon Web Services account in the specified Amazon Web Services\u003cbr/\u003eRegion. An identifier must begin with a letter and must contain only ASCII\u003cbr/\u003eletters, digits, and hyphens; it can\u0026rsquo;t end with a hyphen or contain two consecutive\u003cbr/\u003ehyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequireTLS\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA Boolean parameter that specifies whether Transport Layer Security (TLS)\u003cbr/\u003eencryption is required for connections to the proxy. By enabling this setting,\u003cbr/\u003eyou can enforce encrypted TLS connections to the proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that the proxy uses to access\u003cbr/\u003esecrets in Amazon Web Services Secrets Manager.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn optional set of key-value pairs to associate arbitrary data of your choosing\u003cbr/\u003ewith the proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcSecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more VPC security group IDs to associate with the new proxy. |\n| \u003cstrong\u003evpcSecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcSubnetIDs\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more VPC subnet IDs to associate with the new proxy. |\n| \u003cstrong\u003evpcSubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nendpoint: string\nstatus: string\nupdatedDate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the proxy was first created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint that you can use to connect to the DB proxy. You include the\u003cbr/\u003eendpoint value in the connection string for a database client application.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of this proxy. A status of available means the proxy is\u003cbr/\u003eready to handle requests. Other values indicate that you must wait for the\u003cbr/\u003eproxy to be ready, or take some action to resolve an issue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the proxy was last updated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the VPC ID of the DB proxy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:82,href:"https://aws-controllers-k8s.github.io/community/reference/documentdb/v1alpha1/dbsubnetgroup/",title:"DBSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003edocumentdb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/documentdb-controller/apis/v1alpha1#DBSubnetGroup"\u003edocumentdb-controller/apis/v1alpha1#DBSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetailed information about a subnet group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the subnet group. This value is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Must contain no more than 255 letters, numbers, periods, underscores,\u003cbr/\u003espaces, or hyphens. Must not be default.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mySubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon EC2 subnet IDs for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags to be assigned to the subnet group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon DocumentDB resource consisting of a key-value\npair. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnetGroupStatus: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetStatus: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eDetailed information about one or more subnets within a subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the virtual private cloud (VPC) ID of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:83,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/dbsubnetgroup/",title:"DBSubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#DBSubnetGroup"\u003erds-controller/apis/v1alpha1#DBSubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDBSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edbsubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains the details of an Amazon RDS DB subnet group.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the DescribeDBSubnetGroups\naction.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description for the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the DB subnet group. This value is stored as a lowercase string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must contain no more than 255 letters, numbers, periods, underscores,\u003cbr/\u003e spaces, or hyphens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must not be default.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * First character must be a letter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExample: mydbsubnetgroup\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe EC2 Subnet IDs for the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to assign to the DB subnet group. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata assigned to an Amazon RDS resource consisting of a key-value pair.\u003c/p\u003e\n\u003cp\u003eFor more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html)\nin the Amazon RDS User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnetGroupStatus: string\nsubnets:\n subnetAvailabilityZone: \n name: string\n subnetIdentifier: string\n subnetOutpost: \n arn: string\n subnetStatus: string\nsupportedNetworkTypes:\n- string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of the DB subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of Subnet elements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis data type is used as a response element for the DescribeDBSubnetGroups\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eoperation.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetAvailabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data type that represents an Outpost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about RDS on Outposts, see Amazon RDS on Amazon Web\u003cbr/\u003eServices Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetOutpost.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].subnetStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedNetworkTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe network type of the DB subnet group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IPV4\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DUAL\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6\u003cbr/\u003eprotocols (DUAL).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)\u003cbr/\u003ein the Amazon RDS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedNetworkTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:84,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/deployment/",title:"Deployment",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Deployment"\u003eapigatewayv2-controller/apis/v1alpha1#Deployment\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDeployment\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDeploymentList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edeployments\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edeployment\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn immutable representation of an API that can be called by users. A Deployment\nmust be associated with a Stage for it to be callable over the internet.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\ndescription: string\nstageName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nautoDeployed: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\ndeploymentID: string\ndeploymentStatus: string\ndeploymentStatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoDeployed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:85,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/dhcpoptions/",title:"DHCPOptions",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#DHCPOptions"\u003eec2-controller/apis/v1alpha1#DHCPOptions\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDHCPOptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDHCPOptionsList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edhcpoptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edhcpoptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a set of DHCP options.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edhcpConfigurations:\n- key: string\n values:\n - string\ntags:\n- key: string\n value: string\nvpc:\n- string\nvpcRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA DHCP configuration option.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[].values\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpConfigurations.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndhcpOptionsID: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpOptionsID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the set of DHCP options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the DHCP options set.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:86,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/distribution/",title:"Distribution",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#Distribution"\u003ecloudfront-controller/apis/v1alpha1#Distribution\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDistribution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDistributionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edistributions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edistribution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA distribution tells CloudFront where you want content to be delivered from,\nand the details about how to track and manage content delivery.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edistributionConfig: \n aliases: \n items:\n - string\n cacheBehaviors: \n items:\n allowedMethods: \n cachedMethods: \n items:\n - string\n items:\n - string\n cachePolicyID: string\n compress: boolean\n defaultTTL: integer\n fieldLevelEncryptionID: string\n forwardedValues: \n cookies: \n forward: string\n whitelistedNames: \n items:\n - string\n headers: \n items:\n - string\n queryString: boolean\n queryStringCacheKeys: \n items:\n - string\n functionAssociations: \n items:\n - eventType: string\n functionARN: string\n lambdaFunctionAssociations: \n items:\n - eventType: string\n includeBody: boolean\n lambdaFunctionARN: string\n maxTTL: integer\n minTTL: integer\n originRequestPolicyID: string\n pathPattern: string\n realtimeLogConfigARN: string\n responseHeadersPolicyID: string\n smoothStreaming: boolean\n targetOriginID: string\n trustedKeyGroups: \n enabled: boolean\n items:\n - string\n trustedSigners: \n enabled: boolean\n items:\n - string\n viewerProtocolPolicy: string\n comment: string\n continuousDeploymentPolicyID: string\n customErrorResponses: \n items:\n - errorCachingMinTTL: integer\n errorCode: integer\n responseCode: string\n responsePagePath: string\n defaultCacheBehavior: \n allowedMethods: \n cachedMethods: \n items:\n - string\n items:\n - string\n cachePolicyID: string\n compress: boolean\n defaultTTL: integer\n fieldLevelEncryptionID: string\n forwardedValues: \n cookies: \n forward: string\n whitelistedNames: \n items:\n - string\n headers: \n items:\n - string\n queryString: boolean\n queryStringCacheKeys: \n items:\n - string\n functionAssociations: \n items:\n - eventType: string\n functionARN: string\n lambdaFunctionAssociations: \n items:\n - eventType: string\n includeBody: boolean\n lambdaFunctionARN: string\n maxTTL: integer\n minTTL: integer\n originRequestPolicyID: string\n realtimeLogConfigARN: string\n responseHeadersPolicyID: string\n smoothStreaming: boolean\n targetOriginID: string\n trustedKeyGroups: \n enabled: boolean\n items:\n - string\n trustedSigners: \n enabled: boolean\n items:\n - string\n viewerProtocolPolicy: string\n defaultRootObject: string\n enabled: boolean\n httpVersion: string\n isIPV6Enabled: boolean\n logging: \n bucket: string\n enabled: boolean\n includeCookies: boolean\n prefix: string\n originGroups: \n items:\n failoverCriteria: \n statusCodes: \n items:\n - integer\n id: string\n members: \n items:\n - originID: string\n origins: \n items:\n - connectionAttempts: integer\n connectionTimeout: integer\n customHeaders: \n items:\n - headerName: string\n headerValue: string\n customOriginConfig: \n httpPort: integer\n httpSPort: integer\n originKeepaliveTimeout: integer\n originProtocolPolicy: string\n originReadTimeout: integer\n originSSLProtocols: \n items:\n - string\n domainName: string\n id: string\n originAccessControlID: string\n originPath: string\n originShield: \n enabled: boolean\n originShieldRegion: string\n s3OriginConfig: \n originAccessIdentity: string\n priceClass: string\n restrictions: \n geoRestriction: \n items:\n - string\n restrictionType: string\n staging: boolean\n viewerCertificate: \n acmCertificateARN: string\n acmCertificateRef: \n from: \n name: string\n certificate: string\n certificateSource: string\n cloudFrontDefaultCertificate: boolean\n iamCertificateID: string\n minimumProtocolVersion: string\n sslSupportMethod: string\n webACLID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s configuration information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about CNAMEs (alternate domain names),\u003cbr/\u003eif any, for this distribution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.aliases.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.cacheBehaviors.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edistributionConfig.cacheBehaviors.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that describes how CloudFront processes requests.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou must create at least as many cache behaviors (including the default cache\nbehavior) as you have origins if you want CloudFront to serve objects from\nall of the origins. Each cache behavior specifies the one origin from which\nyou want CloudFront to get objects. If you have two origins and only the\ndefault cache behavior, the default cache behavior will cause CloudFront\nto get objects from one of the origins, but the other origin is never used.\u003c/p\u003e\n\u003cp\u003eFor the current quota (formerly known as limit) on the number of cache behaviors\nthat you can add to a distribution, see Quotas (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html)\nin the Amazon CloudFront Developer Guide.\u003c/p\u003e\n\u003cp\u003eIf you don\u0026rsquo;t want to specify any cache behaviors, include only an empty CacheBehaviors\nelement. Don\u0026rsquo;t include an empty CacheBehavior element because this is invalid.\u003c/p\u003e\n\u003cp\u003eTo delete all cache behaviors in an existing distribution, update the distribution\nconfiguration and include only an empty CacheBehaviors element.\u003c/p\u003e\n\u003cp\u003eTo add, change, or remove one or more cache behaviors, update the distribution\nconfiguration and specify all of the cache behaviors that you want to include\nin the updated distribution.\u003c/p\u003e\n\u003cp\u003eFor more information about cache behaviors, see Cache Behavior Settings (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior)\nin the Amazon CloudFront Developer Guide. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls which HTTP methods CloudFront processes and\u003cbr/\u003eforwards to your Amazon S3 bucket or your custom origin. There are three\u003cbr/\u003echoices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE\u003cbr/\u003e requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the third choice, you may need to restrict access to your Amazon\u003cbr/\u003eS3 bucket or to your custom origin so users can\u0026rsquo;t perform operations that\u003cbr/\u003eyou don\u0026rsquo;t want them to. For example, you might not want users to have permissions\u003cbr/\u003eto delete objects from your origin. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether CloudFront caches the response to requests\u003cbr/\u003eusing the specified HTTP methods. There are two choices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the second choice for your Amazon S3 Origin, you may need to\u003cbr/\u003eforward Access-Control-Request-Method, Access-Control-Request-Headers, and\u003cbr/\u003eOrigin headers for the responses to be cached correctly. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.cachedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].allowedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].cachePolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].compress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].fieldLevelEncryptionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include values in the cache key, use a cache policy. For more\u003cbr/\u003einformation, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send values to the origin but not include them in the cache\u003cbr/\u003ekey, use an origin request policy. For more information, see Creating origin\u003cbr/\u003erequest policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies how CloudFront handles query strings, cookies,\u003cbr/\u003eand HTTP headers. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include cookies in the cache key, use CookiesConfig in a cache\u003cbr/\u003epolicy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send cookies to the origin but not include them in the cache\u003cbr/\u003ekey, use CookiesConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies whether you want CloudFront to forward cookies\u003cbr/\u003eto the origin and, if so, which ones. For more information about forwarding\u003cbr/\u003ecookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.forward\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.cookies.whitelistedNames.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryString\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include query strings in the cache key, use QueryStringsConfig\u003cbr/\u003ein a cache policy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send query strings to the origin but not include them in the\u003cbr/\u003ecache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that contains information about the query string parameters\u003cbr/\u003ethat you want CloudFront to use for caching for a cache behavior. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].forwardedValues.queryStringCacheKeys.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront functions that are associated with a cache behavior\u003cbr/\u003ein a CloudFront distribution. CloudFront functions must be published to the\u003cbr/\u003eLIVE stage to associate them with a cache behavior. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA CloudFront function that is associated with a cache behavior in a CloudFront\ndistribution. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].functionAssociations.items.[].functionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that specifies a list of Lambda@Edge functions associations\u003cbr/\u003efor a cache behavior.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to invoke one or more Lambda@Edge functions triggered by requests\u003cbr/\u003ethat match the PathPattern of the cache behavior, specify the applicable\u003cbr/\u003evalues for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation\u003cbr/\u003eitems in this list (one for each possible value of EventType) and each EventType\u003cbr/\u003ecan be associated with only one function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t want to invoke any Lambda@Edge functions for the requests that\u003cbr/\u003ematch PathPattern, specify 0 for Quantity and omit Items. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a Lambda@Edge function association. || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].includeBody\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].lambdaFunctionAssociations.items.[].lambdaFunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].minTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].originRequestPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].pathPattern\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].realtimeLogConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].responseHeadersPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].smoothStreaming\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].targetOriginID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of key groups whose public keys CloudFront can use to verify the signatures\u003cbr/\u003eof signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts whose public keys CloudFront can use\u003cbr/\u003eto verify the signatures of signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].trustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.cacheBehaviors.items.[].viewerProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.continuousDeploymentPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range\u003cbr/\u003e with custom error messages before returning the response to the viewer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * How long CloudFront caches HTTP status codes in the 4xx and 5xx range.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about custom error pages, see Customizing Error Responses\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eWhether CloudFront replaces HTTP status codes in the 4xx and 5xx range\nwith custom error messages before returning the response to the viewer.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eHow long CloudFront caches HTTP status codes in the 4xx and 5xx range.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information about custom error pages, see Customizing Error Responses\n(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html)\nin the Amazon CloudFront Developer Guide. || \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].errorCachingMinTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].errorCode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].responseCode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.customErrorResponses.items.[].responsePagePath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that describes the default cache behavior if you don\u0026rsquo;t specify\u003cbr/\u003ea CacheBehavior element or if request URLs don\u0026rsquo;t match any of the values\u003cbr/\u003eof PathPattern in CacheBehavior elements. You must create exactly one default\u003cbr/\u003ecache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls which HTTP methods CloudFront processes and\u003cbr/\u003eforwards to your Amazon S3 bucket or your custom origin. There are three\u003cbr/\u003echoices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards only GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE\u003cbr/\u003e requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the third choice, you may need to restrict access to your Amazon\u003cbr/\u003eS3 bucket or to your custom origin so users can\u0026rsquo;t perform operations that\u003cbr/\u003eyou don\u0026rsquo;t want them to. For example, you might not want users to have permissions\u003cbr/\u003eto delete objects from your origin. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether CloudFront caches the response to requests\u003cbr/\u003eusing the specified HTTP methods. There are two choices:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET and HEAD requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront caches responses to GET, HEAD, and OPTIONS requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you pick the second choice for your Amazon S3 Origin, you may need to\u003cbr/\u003eforward Access-Control-Request-Method, Access-Control-Request-Headers, and\u003cbr/\u003eOrigin headers for the responses to be cached correctly. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.cachedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.allowedMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.cachePolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.compress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.defaultTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.fieldLevelEncryptionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include values in the cache key, use a cache policy. For more\u003cbr/\u003einformation, see Creating cache policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send values to the origin but not include them in the cache\u003cbr/\u003ekey, use an origin request policy. For more information, see Creating origin\u003cbr/\u003erequest policies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies how CloudFront handles query strings, cookies,\u003cbr/\u003eand HTTP headers. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include cookies in the cache key, use CookiesConfig in a cache\u003cbr/\u003epolicy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send cookies to the origin but not include them in the cache\u003cbr/\u003ekey, use CookiesConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that specifies whether you want CloudFront to forward cookies\u003cbr/\u003eto the origin and, if so, which ones. For more information about forwarding\u003cbr/\u003ecookies to the origin, see Caching Content Based on Cookies (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.forward\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.cookies.whitelistedNames.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryString\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field is deprecated. We recommend that you use a cache policy or an\u003cbr/\u003eorigin request policy instead of this field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to include query strings in the cache key, use QueryStringsConfig\u003cbr/\u003ein a cache policy. See CachePolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to send query strings to the origin but not include them in the\u003cbr/\u003ecache key, use QueryStringsConfig in an origin request policy. See OriginRequestPolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA complex type that contains information about the query string parameters\u003cbr/\u003ethat you want CloudFront to use for caching for a cache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.forwardedValues.queryStringCacheKeys.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront functions that are associated with a cache behavior\u003cbr/\u003ein a CloudFront distribution. CloudFront functions must be published to the\u003cbr/\u003eLIVE stage to associate them with a cache behavior. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA CloudFront function that is associated with a cache behavior in a CloudFront\ndistribution. || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.functionAssociations.items.[].functionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that specifies a list of Lambda@Edge functions associations\u003cbr/\u003efor a cache behavior.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you want to invoke one or more Lambda@Edge functions triggered by requests\u003cbr/\u003ethat match the PathPattern of the cache behavior, specify the applicable\u003cbr/\u003evalues for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation\u003cbr/\u003eitems in this list (one for each possible value of EventType) and each EventType\u003cbr/\u003ecan be associated with only one function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t want to invoke any Lambda@Edge functions for the requests that\u003cbr/\u003ematch PathPattern, specify 0 for Quantity and omit Items. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a Lambda@Edge function association. || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].eventType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].includeBody\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.lambdaFunctionAssociations.items.[].lambdaFunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.maxTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.minTTL\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.originRequestPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.realtimeLogConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.responseHeadersPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.smoothStreaming\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.targetOriginID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of key groups whose public keys CloudFront can use to verify the signatures\u003cbr/\u003eof signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts whose public keys CloudFront can use\u003cbr/\u003eto verify the signatures of signed URLs and signed cookies. |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultCacheBehavior.trustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.defaultCacheBehavior.viewerProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.defaultRootObject\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.httpVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.isIPV6Enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls whether access logs are written for the distribution. |\n| \u003cstrong\u003edistributionConfig.logging.bucket\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.includeCookies\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.logging.prefix\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.originGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the origin groups specified for a distribution. |\n| \u003cstrong\u003edistributionConfig.originGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of origin groups for a distribution. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin group includes two origins (a primary origin and a second origin\nto failover to) and a failover criteria that you specify. You create an origin\ngroup to support origin failover in CloudFront. When you create or update\na distribution, you can specifiy the origin group instead of a single origin,\nand CloudFront will failover from the primary origin to the second origin\nunder the failover conditions that you\u0026rsquo;ve chosen. || \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type that includes information about the failover criteria\u003cbr/\u003efor an origin group, including the status codes for which CloudFront will\u003cbr/\u003efailover from the primary origin to the second origin. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the status codes that you specify that, when returned\u003cbr/\u003eby a primary origin, trigger CloudFront to failover to a second origin. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of status codes for origin failover. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].failoverCriteria.statusCodes.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.originGroups.items.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex data type for the origins included in an origin group. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of origins in an origin group. |\n| \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin in an origin group. || \u003cstrong\u003edistributionConfig.originGroups.items.[].members.items.[].originID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the origins for this distribution. |\n| \u003cstrong\u003edistributionConfig.origins.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin.\u003c/p\u003e\n\u003cp\u003eAn origin is the location where content is stored, and from which CloudFront\ngets content to serve to viewers. To specify an origin:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eUse S3OriginConfig to specify an Amazon S3 bucket that is not configured\nwith static website hosting.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eUse CustomOriginConfig to specify all other kinds of origins, including:\nAn Amazon S3 bucket that is configured with static website hosting An\nElastic Load Balancing load balancer An AWS Elemental MediaPackage endpoint\nAn AWS Elemental MediaStore container Any other HTTP server, running on\nan Amazon EC2 instance or any other kind of host\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor the current maximum number of origins that you can specify per distribution,\nsee General Quotas on Web Distributions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions)\nin the Amazon CloudFront Developer Guide (quotas were formerly referred to\nas limits). || \u003cstrong\u003edistributionConfig.origins.items.[].connectionAttempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].connectionTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains the list of Custom Headers for each origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains HeaderName and HeaderValue elements, if any,\nfor this distribution. || \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[].headerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customHeaders.items.[].headerValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom origin. A custom origin is any origin that is not an Amazon S3 bucket,\u003cbr/\u003ewith one exception. An Amazon S3 bucket that is configured with static website\u003cbr/\u003ehosting (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html)\u003cbr/\u003eis a custom origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.httpPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.httpSPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originKeepaliveTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originProtocolPolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originReadTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about the SSL/TLS protocols that\u003cbr/\u003eCloudFront can use when establishing an HTTPS connection with your origin. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].customOriginConfig.originSSLProtocols.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.origins.items.[].domainName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originAccessControlID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCloudFront Origin Shield.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUsing Origin Shield can help reduce the load on your origin. For more information,\u003cbr/\u003esee Using Origin Shield (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].originShield.originShieldRegion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.origins.items.[].s3OriginConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about the Amazon S3 origin. If the\u003cbr/\u003eorigin is a custom origin or an S3 bucket that is configured as a website\u003cbr/\u003eendpoint, use the CustomOriginConfig element instead. |\n| \u003cstrong\u003edistributionConfig.origins.items.[].s3OriginConfig.originAccessIdentity\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.priceClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.restrictions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that identifies ways in which you want to restrict distribution\u003cbr/\u003eof your content. |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that controls the countries in which your content is distributed.\u003cbr/\u003eCloudFront determines the location of your users using MaxMind GeoIP databases. |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.items\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edistributionConfig.restrictions.geoRestriction.restrictionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.staging\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that determines the distribution\u0026rsquo;s SSL/TLS configuration for\u003cbr/\u003ecommunicating with viewers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the distribution doesn\u0026rsquo;t use Aliases (also known as alternate domain names\u003cbr/\u003eor CNAMEs)—that is, if the distribution uses the CloudFront domain name\u003cbr/\u003esuch as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate\u003cbr/\u003eto true and leave all other fields empty.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the distribution uses Aliases (alternate domain names or CNAMEs), use\u003cbr/\u003ethe fields in this type to specify the following settings:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Which viewers the distribution accepts HTTPS connections from: only\u003cbr/\u003e viewers that support server name indication (SNI) (https://en.wikipedia.org/wiki/Server_Name_Indication)\u003cbr/\u003e (recommended), or all viewers including those that don\u0026rsquo;t support SNI.\u003cbr/\u003e To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod\u003cbr/\u003e to sni-only. This is recommended. Most browsers and clients support SNI.\u003cbr/\u003e To accept HTTPS connections from all viewers, including those that don\u0026rsquo;t\u003cbr/\u003e support SNI, set SSLSupportMethod to vip. This is not recommended, and\u003cbr/\u003e results in additional monthly charges from CloudFront.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The minimum SSL/TLS protocol version that the distribution can use to\u003cbr/\u003e communicate with viewers. To specify a minimum version, choose a value\u003cbr/\u003e for MinimumProtocolVersion. For more information, see Security Policy\u003cbr/\u003e (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy)\u003cbr/\u003e in the Amazon CloudFront Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The location of the SSL/TLS certificate, Certificate Manager (ACM) (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html)\u003cbr/\u003e (recommended) or Identity and Access Management (IAM) (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html).\u003cbr/\u003e You specify the location by setting a value in one of the following fields\u003cbr/\u003e (not both): ACMCertificateArn IAMCertificateId\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll distributions support HTTPS connections from viewers. To require viewers\u003cbr/\u003eto use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy\u003cbr/\u003ein the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should\u003cbr/\u003euse SSL/TLS to communicate with your custom origin, use CustomOriginConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Using HTTPS with CloudFront (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html)\u003cbr/\u003eand Using Alternate Domain Names and HTTPS (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide. |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for ACMCertificateARN |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.acmCertificateRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.certificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.certificateSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.cloudFrontDefaultCertificate\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.iamCertificateID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.minimumProtocolVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.viewerCertificate.sslSupportMethod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edistributionConfig.webACLID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nactiveTrustedKeyGroups: \n enabled: boolean\n items:\n - keyGroupID: string\n keyPairIDs: \n items:\n - string\n quantity: integer\nactiveTrustedSigners: \n enabled: boolean\n items:\n - awsAccountNumber: string\n keyPairIDs: \n items:\n - string\n quantity: integer\naliasICPRecordals:\n- cname: string\n iCPRecordalStatus: string\ncallerReference: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndomainName: string\neTag: string\nid: string\ninProgressInvalidationBatches: integer\nlastModifiedTime: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis field contains a list of key groups and the public keys in each key\u003cbr/\u003egroup that CloudFront can use to verify the signatures of signed URLs or\u003cbr/\u003esigned cookies.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of identifiers for the public keys that CloudFront can use to verify\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe signatures of signed URLs and signed cookies.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront key pair identifiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedKeyGroups.items.[].keyPairIDs.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe recommend using TrustedKeyGroups instead of TrustedSigners.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis field contains a list of Amazon Web Services account IDs and the active\u003cbr/\u003eCloudFront key pairs in each account that CloudFront can use to verify the\u003cbr/\u003esignatures of signed URLs or signed cookies.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Web Services accounts and the active CloudFront key pairs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein each account that CloudFront can use to verify the signatures of signed\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eURLs and signed cookies.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of CloudFront key pair identifiers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactiveTrustedSigners.items.[].keyPairIDs.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasICPRecordals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services services in China customers must file for an Internet\u003cbr/\u003eContent Provider (ICP) recordal if they want to serve content publicly on\u003cbr/\u003ean alternate domain name, also known as a CNAME, that they\u0026rsquo;ve added to CloudFront.\u003cbr/\u003eAliasICPRecordal provides the ICP recordal status for CNAMEs associated with\u003cbr/\u003edistributions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about ICP recordals, see Signup, Accounts, and Credentials\u003cbr/\u003e(https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html)\u003cbr/\u003ein Getting Started with Amazon Web Services services in China.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasICPRecordals.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services services in China customers must file for an Internet\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eContent Provider (ICP) recordal if they want to serve content publicly on\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ean alternate domain name, also known as a CNAME, that they\u0026rsquo;ve added to CloudFront.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAliasICPRecordal provides the ICP recordal status for CNAMEs associated with\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edistributions. The status is returned in the CloudFront response; you can\u0026rsquo;t\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econfigure it yourself.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor more information about ICP recordals, see Signup, Accounts, and Credentials\n(https://docs.amazonaws.cn/en_us/aws/latest/userguide/accounts-and-credentials.html)\nin Getting Started with Amazon Web Services services in China. || \u003cstrong\u003ealiasICPRecordals.[].cname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ealiasICPRecordals.[].iCPRecordalStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecallerReference\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource |\n| \u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\ncontrollers to indicate terminal states of the CR and its backend AWS\nservice API resource || \u003cstrong\u003econditions.[].lastTransitionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLast time the condition transitioned from one status to another. |\n| \u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition. |\n| \u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition. |\n| \u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown. |\n| \u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition |\n| \u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s CloudFront domain name. For example: d111111abcdef8.cloudfront.net. |\n| \u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current version of the distribution created. |\n| \u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s identifier. For example: E1U5RQF7T870K0. |\n| \u003cstrong\u003einProgressInvalidationBatches\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of invalidation batches currently in progress. |\n| \u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the distribution was last modified. |\n| \u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe distribution\u0026rsquo;s status. When the status is Deployed, the distribution\u0026rsquo;s\u003cbr/\u003einformation is fully propagated to all CloudFront edge locations. |\u003c/p\u003e\n'}).add({id:87,href:"https://aws-controllers-k8s.github.io/community/docs/",title:"Docs",description:null,content:""}).add({id:88,href:"https://aws-controllers-k8s.github.io/community/reference/opensearchservice/v1alpha1/domain/",title:"Domain",description:null,content:'\u003cp\u003e\u003ccode\u003eopensearchservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/opensearchservice-controller/apis/v1alpha1#Domain"\u003eopensearchservice-controller/apis/v1alpha1#Domain\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomainList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomains\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessPolicies: string\nadvancedOptions: {}\nadvancedSecurityOptions: \n anonymousAuthEnabled: boolean\n enabled: boolean\n internalUserDatabaseEnabled: boolean\n masterUserOptions: \n masterUserARN: string\n masterUserName: string\n masterUserPassword: \n key: string\n name: string\n namespace: string\n sAMLOptions: \n enabled: boolean\n idp: \n entityID: string\n metadataContent: string\n masterBackendRole: string\n masterUserName: string\n rolesKey: string\n sessionTimeoutMinutes: integer\n subjectKey: string\nautoTuneOptions: \n desiredState: string\n maintenanceSchedules:\n - cronExpressionForRecurrence: string\n duration: \n unit: string\n value: integer\n startAt: string\nclusterConfig: \n coldStorageOptions: \n enabled: boolean\n dedicatedMasterCount: integer\n dedicatedMasterEnabled: boolean\n dedicatedMasterType: string\n instanceCount: integer\n instanceType: string\n warmCount: integer\n warmEnabled: boolean\n warmType: string\n zoneAwarenessConfig: \n availabilityZoneCount: integer\n zoneAwarenessEnabled: boolean\ncognitoOptions: \n enabled: boolean\n identityPoolID: string\n roleARN: string\n userPoolID: string\ndomainEndpointOptions: \n customEndpoint: string\n customEndpointCertificateARN: string\n customEndpointEnabled: boolean\n enforceHTTPS: boolean\n tlsSecurityPolicy: string\nebsOptions: \n ebsEnabled: boolean\n iops: integer\n throughput: integer\n volumeSize: integer\n volumeType: string\nencryptionAtRestOptions: \n enabled: boolean\n kmsKeyID: string\nengineVersion: string\nlogPublishingOptions: {}\nname: string\nnodeToNodeEncryptionOptions: \n enabled: boolean\ntags:\n- key: string\n value: string\nvpcOptions: \n securityGroupIDs:\n - string\n subnetIDs:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessPolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIAM access policy as a JSON-formatted string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOption to allow references to indices in an HTTP request body. Must be false\u003cbr/\u003ewhen configuring access to individual sub-resources. By default, the value\u003cbr/\u003eis true. See Advanced cluster parameters (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomain-configure-advanced-options)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies advanced security options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.anonymousAuthEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.internalUserDatabaseEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCredentials for the master user: username and password, ARN, or both.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities\u003cbr/\u003e(http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS\u003cbr/\u003eIdentity and Access Management for more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a\u003cbr/\u003especific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.masterUserOptions.masterUserPassword.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe SAML application configuration for the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe SAML identity povider\u0026rsquo;s information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp.entityID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.idp.metadataContent\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.masterBackendRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.masterUserName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.rolesKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.sessionTimeoutMinutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedSecurityOptions.sAMLOptions.subjectKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies Auto-Tune options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.desiredState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Auto-Tune desired state. Valid values are ENABLED and DISABLED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eService (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor more information.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe maintenance schedule duration: duration value and duration unit. See\u003cbr/\u003eAuto-Tune for Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration.unit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune\u003cbr/\u003efor Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].duration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eInteger to specify the value of a maintenance schedule duration. See Auto-Tune\u003cbr/\u003efor Amazon OpenSearch Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/auto-tune.html)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoTuneOptions.maintenanceSchedules.[].startAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration options for a domain. Specifies the instance type and number\u003cbr/\u003eof instances in the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.coldStorageOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for cold storage options such as enabled\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.coldStorageOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.dedicatedMasterType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.warmType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe zone awareness configuration for the domain cluster, such as the number\u003cbr/\u003eof availability zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessConfig.availabilityZoneCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfig.zoneAwarenessEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify the Cognito user and identity pools for OpenSearch Dashboards\u003cbr/\u003eauthentication. For more information, see Configuring Amazon Cognito authentication\u003cbr/\u003efor OpenSearch Dashboards (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/cognito-auth.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.identityPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecognitoOptions.userPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify configurations that will be applied to the domain endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpointCertificateARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the domain. See Identifiers for IAM Entities\u003cbr/\u003e(http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html) in Using AWS\u003cbr/\u003eIdentity and Access Management for more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.customEndpointEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.enforceHTTPS\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainEndpointOptions.tlsSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to enable, disable, and specify the type and size of EBS storage\u003cbr/\u003evolumes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.ebsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.throughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptions.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of EBS volume, standard, gp2, gp3 or io1. See Configuring EBS-based\u003cbr/\u003eStorage (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/opensearch-createupdatedomains.html#opensearch-createdomain-configure-ebs)\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions for encryption of data at rest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAtRestOptions.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eString of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine\u003cbr/\u003eversion for the Amazon OpenSearch Service domain. For example, \u0026ldquo;OpenSearch_1.0\u0026rdquo;\u003cbr/\u003eor \u0026ldquo;Elasticsearch_7.9\u0026rdquo;. For more information, see Creating and managing Amazon\u003cbr/\u003eOpenSearch Service domains (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/createupdatedomains.html#createdomains).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogPublishingOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap of LogType and LogPublishingOption, each containing options to publish\u003cbr/\u003ea given type of OpenSearch log.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Amazon OpenSearch Service domain you\u0026rsquo;re creating. Domain\u003cbr/\u003enames are unique across the domains owned by an account within an AWS region.\u003cbr/\u003eDomain names must start with a lowercase letter and can contain the following\u003cbr/\u003echaracters: a-z (lowercase), 0-9, and - (hyphen).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeToNodeEncryptionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode-to-node encryption options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeToNodeEncryptionOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Tag added during domain creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key value pair for a resource tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string of length from 0 to 256 characters that specifies the value for\u003cbr/\u003ea tag. Tag values can be null and don\u0026rsquo;t have to be unique in a tag set.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptions to specify the subnets and security groups for a VPC endpoint. For\u003cbr/\u003emore information, see Launching your Amazon OpenSearch Service domains using\u003cbr/\u003ea VPC (http://docs.aws.amazon.com/opensearch-service/latest/developerguide/vpc.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcOptions.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nchangeProgressDetails: \n changeID: string\n message: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreated: boolean\ndeleted: boolean\ndomainID: string\nendpoint: string\nendpoints: {}\nprocessing: boolean\nserviceSoftwareOptions: \n automatedUpdateDate: string\n cancellable: boolean\n currentVersion: string\n description: string\n newVersion: string\n optionalDeployment: boolean\n updateAvailable: boolean\n updateStatus: string\nsnapshotOptions: \n automatedSnapshotStartHour: integer\nupgradeProcessing: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies change details of the domain configuration change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails.changeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeProgressDetails.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe domain creation status. True if the creation of a domain is complete.\u003cbr/\u003eFalse if domain creation is still in progress.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe domain deletion status. True if a delete request has been received for\u003cbr/\u003ethe domain but resource cleanup is still in progress. False if the domain\u003cbr/\u003ehas not been deleted. Once domain deletion is complete, the status of the\u003cbr/\u003edomain is no longer returned.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the specified domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain endpoint that you use to submit index and search requests.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMap containing the domain endpoints used to submit index and search requests.\u003cbr/\u003eExample key, value: \u0026lsquo;vpc\u0026rsquo;,\u0026lsquo;vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com\u0026rsquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe status of the domain configuration. True if Amazon OpenSearch Service\u003cbr/\u003eis processing configuration changes. False if the configuration is active.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe current status of the domain\u0026rsquo;s service software.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.automatedUpdateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.cancellable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.currentVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.newVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.optionalDeployment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.updateAvailable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceSoftwareOptions.updateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the SnapshotOptions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotOptions.automatedSnapshotStartHour\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupgradeProcessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe status of a domain version upgrade. True if Amazon OpenSearch Service\u003cbr/\u003eis undergoing a version upgrade. False if the configuration is active.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:89,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/domain/",title:"Domain",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Domain"\u003esagemaker-controller/apis/v1alpha1#Domain\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eDomainList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomains\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003edomain\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappNetworkAccessType: string\nappSecurityGroupManagement: string\nauthMode: string\ndefaultUserSettings: \n codeEditorAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n customFileSystemConfigs:\n efsFileSystemConfig: \n fileSystemID: string\n fileSystemPath: string\n customPosixUserConfig: \n gid: integer\n uid: integer\n defaultLandingURI: string\n executionRole: string\n jupyterLabAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n jupyterServerAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n kernelGatewayAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n rStudioServerProAppSettings: \n accessStatus: string\n userGroup: string\n securityGroups:\n - string\n sharingSettings: \n notebookOutputOption: string\n s3KMSKeyID: string\n s3OutputPath: string\n spaceStorageSettings: \n defaultEBSStorageSettings: \n defaultEBSVolumeSizeInGb: integer\n maximumEBSVolumeSizeInGb: integer\n studioWebPortal: string\n tensorBoardAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\ndomainName: string\ndomainSettings: \n dockerSettings: \n enableDockerAccess: string\n vpcOnlyTrustedAccounts:\n - string\n rStudioServerProDomainSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n domainExecutionRoleARN: string\n rStudioConnectURL: string\n rStudioPackageManagerURL: string\n securityGroupIDs:\n - string\nhomeEFSFileSystemKMSKeyID: string\nkmsKeyID: string\nsubnetIDs:\n- string\ntags:\n- key: string\n value: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappNetworkAccessType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon\u003cbr/\u003e SageMaker, which allows direct internet access\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * VpcOnly - All traffic is through the specified VPC and subnets\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSecurityGroupManagement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe entity that creates and manages the required security groups for inter-app\u003cbr/\u003ecommunication in VPCOnly mode. Required when CreateDomain.AppNetworkAccessType\u003cbr/\u003eis VPCOnly and DomainSettings.RStudioServerProDomainSettings.DomainExecutionRoleArn\u003cbr/\u003eis provided. If setting up the domain for use with RStudio, this value must\u003cbr/\u003ebe set to Service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe mode of authentication that members use to access the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default settings to use to create a user profile when UserSettings isn\u0026rsquo;t\u003cbr/\u003especified in the call to the CreateUserProfile API.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSecurityGroups is aggregated when specified in both calls. For all other\u003cbr/\u003esettings in UserSettings, the values specified in CreateUserProfile take\u003cbr/\u003eprecedence over those specified in CreateDomain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Code Editor application settings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Code Editor, see Get started with Code Editor\u003cbr/\u003ein Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.codeEditorAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom file system to a user profile or space\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor an Amazon SageMaker Domain. Permitted users can access this file system\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Amazon SageMaker Studio.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the POSIX identity that is used for file system operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig.gid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.customPosixUserConfig.uid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.defaultLandingURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.executionRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for the JupyterLab application.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterLabAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.rStudioServerProAppSettings.accessStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.rStudioServerProAppSettings.userGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.notebookOutputOption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.s3KMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.sharingSettings.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default storage settings for a private space.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of default EBS storage settings that applies to private spaces\u003cbr/\u003ecreated within a domain or user profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.studioWebPortal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TensorBoard app settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultUserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of Domain settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings that configure the domain\u0026rsquo;s Docker interaction.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.enableDockerAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.vpcOnlyTrustedAccounts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.dockerSettings.vpcOnlyTrustedAccounts.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.domainExecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.rStudioConnectURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.rStudioServerProDomainSettings.rStudioPackageManagerURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainSettings.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSageMaker uses Amazon Web Services KMS to encrypt the EFS volume attached\u003cbr/\u003eto the domain with an Amazon Web Services managed key by default. For more\u003cbr/\u003econtrol, specify a customer managed key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe VPC subnets that the domain uses for communication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Virtual Private Cloud (VPC) that the domain uses for\u003cbr/\u003ecommunication. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndomainID: string\nstatus: string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe domain ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eurl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL to the created domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:90,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/elasticipaddress/",title:"ElasticIPAddress",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#ElasticIPAddress"\u003eec2-controller/apis/v1alpha1#ElasticIPAddress\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eElasticIPAddress\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eElasticIPAddressList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eelasticipaddresses\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eelasticipaddress\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaddress: string\ncustomerOwnedIPv4Pool: string\nnetworkBorderGroup: string\npublicIPv4Pool: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address\u003cbr/\u003epool.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of a customer-owned address pool. Use this parameter to let Amazon\u003cbr/\u003eEC2 select an address from the address pool. Alternatively, specify a specific\u003cbr/\u003eaddress from the address pool.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique set of Availability Zones, Local Zones, or Wavelength Zones from\u003cbr/\u003ewhich Amazon Web Services advertises IP addresses. Use this parameter to\u003cbr/\u003elimit the IP address to this location. IP addresses cannot move between network\u003cbr/\u003eborder groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse DescribeAvailabilityZones (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html)\u003cbr/\u003eto view the network border groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use a network border group with EC2 Classic. If you attempt this\u003cbr/\u003eoperation on EC2 Classic, you receive an InvalidParameterCombination error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an address pool that you own. Use this parameter to let Amazon\u003cbr/\u003eEC2 select an address from the address pool. To specify a specific address\u003cbr/\u003efrom the address pool, use the Address parameter instead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallocationID: string\ncarrierIP: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncustomerOwnedIP: string\npublicIP: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation\u003cbr/\u003eof the Elastic IP address for use with instances in a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecarrierIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe carrier IP address. This option is only available for network interfaces\u003cbr/\u003ewhich reside in a subnet in a Wavelength Zone (for example an EC2 instance).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe customer-owned IP address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Elastic IP address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:91,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/endpoint/",title:"Endpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Endpoint"\u003eeventbridge-controller/apis/v1alpha1#Endpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA global endpoint used to improve your application\u0026rsquo;s availability by making\nit regional-fault tolerant. For more information about global endpoints,\nsee Making applications Regional-fault tolerant with global endpoints and\nevent replication (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html)\nin the Amazon EventBridge User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventBuses:\n- eventBusARN: string\nname: string\nreplicationConfig: \n state: string\nroleARN: string\nroutingConfig: \n failoverConfig: \n primary: \n healthCheck: string\n secondary: \n route: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the global endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBuses\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eDefine the event buses used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe names of the event buses must be identical in each Region.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe event buses the endpoint is associated with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the global endpoint. For example, \u0026ldquo;Name\u0026rdquo;:\u0026ldquo;us-east-2-custom_bus_A-endpoint\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnable or disable event replication. The default state is ENABLED which means\u003cbr/\u003eyou must supply a RoleArn. If you don\u0026rsquo;t have a RoleArn or you don\u0026rsquo;t want\u003cbr/\u003eevent replication enabled, set the state to DISABLED.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationConfig.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the role used for replication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigure the routing policy, including the health check and secondary Region..\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe failover configuration for an endpoint. This includes what triggers failover\u003cbr/\u003eand what happens when it\u0026rsquo;s triggered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.primary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe primary Region of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.primary.healthCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.secondary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe secondary Region that processes events when failover is triggered or\u003cbr/\u003ereplication is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutingConfig.failoverConfig.secondary.route\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstate: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the endpoint that was created by this request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the endpoint you asked for information about is in its current\u003cbr/\u003estate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:92,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/endpoint/",title:"Endpoint",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Endpoint"\u003esagemaker-controller/apis/v1alpha1#Endpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA hosted endpoint for real-time inference.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeploymentConfig: \n autoRollbackConfiguration: \n alarms:\n - alarmName: string\n blueGreenUpdatePolicy: \n maximumExecutionTimeoutInSeconds: integer\n terminationWaitInSeconds: integer\n trafficRoutingConfiguration: \n canarySize: \n type_: string\n value: integer\n linearStepSize: \n type_: string\n value: integer\n type_: string\n waitIntervalInSeconds: integer\n rollingUpdatePolicy: \n maximumBatchSize: \n type_: string\n value: integer\n maximumExecutionTimeoutInSeconds: integer\n rollbackMaximumBatchSize: \n type_: string\n value: integer\n waitIntervalInSeconds: integer\nendpointConfigName: string\nendpointName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment configuration for an endpoint, which contains the desired\u003cbr/\u003edeployment strategy and rollback configurations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAutomatic rollback configuration for handling endpoint deployment failures\u003cbr/\u003eand recovery.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration.alarms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.autoRollbackConfiguration.alarms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Amazon CloudWatch alarm configured to monitor metrics on an endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUpdate policy for a blue/green deployment. If this update policy is specified,\u003cbr/\u003eSageMaker creates a new fleet during the deployment while maintaining the\u003cbr/\u003eold fleet. SageMaker flips traffic to the new fleet according to the specified\u003cbr/\u003etraffic routing configuration. Only one update policy should be used in the\u003cbr/\u003edeployment configuration. If no update policy is specified, SageMaker uses\u003cbr/\u003ea blue/green deployment strategy with all at once traffic shifting by default.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.maximumExecutionTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.terminationWaitInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the traffic routing strategy during an endpoint deployment to shift\u003cbr/\u003etraffic from the old fleet to the new fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.canarySize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.linearStepSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.blueGreenUpdatePolicy.trafficRoutingConfiguration.waitIntervalInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a rolling deployment strategy for updating a SageMaker endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumBatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.rollingUpdatePolicy.maximumBatchSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumBatchSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.maximumExecutionTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the type and size of the endpoint capacity to activate for a blue/green\u003cbr/\u003edeployment, a rolling deployment, or a rollback strategy. You can specify\u003cbr/\u003eyour batches as either instance count or the overall percentage or your fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a rollback strategy, if you don\u0026rsquo;t specify the fields in this object,\u003cbr/\u003eor if you set the Value to 100%, then SageMaker uses a blue/green rollback\u003cbr/\u003estrategy and rolls all traffic back to the blue fleet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**deploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.rollbackMaximumBatchSize.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentConfig.rollingUpdatePolicy.waitIntervalInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an endpoint configuration. For more information, see CreateEndpointConfig\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpointConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the endpoint.The name must be unique within an Amazon Web Services\u003cbr/\u003eRegion in your Amazon Web Services account. The name is case-insensitive\u003cbr/\u003ein CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nendpointStatus: string\nfailureReason: string\nlastModifiedTime: string\npendingDeploymentSummary: \n endpointConfigName: string\n productionVariants:\n - acceleratorType: string\n currentInstanceCount: integer\n currentServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n currentWeight: number\n deployedImages:\n - resolutionTime: string\n resolvedImage: string\n specifiedImage: string\n desiredInstanceCount: integer\n desiredServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n desiredWeight: number\n instanceType: string\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n routingConfig: \n routingStrategy: string\n variantName: string\n variantStatus:\n - startTime: string\n status: string\n statusMessage: string\n startTime: string\nproductionVariants:\n- currentInstanceCount: integer\n currentServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n currentWeight: number\n deployedImages:\n - resolutionTime: string\n resolvedImage: string\n specifiedImage: string\n desiredInstanceCount: integer\n desiredServerlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n desiredWeight: number\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n routingConfig: \n routingStrategy: string\n variantName: string\n variantStatus:\n - startTime: string\n status: string\n statusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that shows when the endpoint was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OutOfService: Endpoint is not available to take incoming requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Creating: CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Updating: UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html)\u003cbr/\u003e or UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SystemUpdating: Endpoint is undergoing maintenance and cannot be updated\u003cbr/\u003e or deleted or re-scaled until it has completed. This maintenance operation\u003cbr/\u003e does not change any customer-specified values such as VPC config, KMS\u003cbr/\u003e encryption, model, instance type, or instance count.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RollingBack: Endpoint fails to scale up or down or change its variant\u003cbr/\u003e weight and is in the process of rolling back to its previous configuration.\u003cbr/\u003e Once the rollback completes, endpoint returns to an InService status.\u003cbr/\u003e This transitional status only applies to an endpoint that has autoscaling\u003cbr/\u003e enabled and is undergoing variant weight or capacity changes as part of\u003cbr/\u003e an UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e call or when the UpdateEndpointWeightsAndCapacities (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpointWeightsAndCapacities.html)\u003cbr/\u003e operation is called explicitly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InService: Endpoint is available to process incoming requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Deleting: DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)\u003cbr/\u003e is executing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed: Endpoint could not be created, updated, or re-scaled. Use the\u003cbr/\u003e FailureReason value returned by DescribeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeEndpoint.html)\u003cbr/\u003e for information about the failure. DeleteEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DeleteEndpoint.html)\u003cbr/\u003e is the only operation that can be performed on a failed endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UpdateRollbackFailed: Both the rolling deployment and auto-rollback\u003cbr/\u003e failed. Your endpoint is in service with a mix of the old and new endpoint\u003cbr/\u003e configurations. For information about how to remedy this issue and restore\u003cbr/\u003e the endpoint\u0026rsquo;s status to InService, see Rolling Deployments (https://docs.aws.amazon.com/sagemaker/latest/dg/deployment-guardrails-rolling.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the status of the endpoint is Failed, the reason why it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that shows when the endpoint was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns the summary of an in-progress deployment. This field is only returned\u003cbr/\u003ewhen the endpoint is creating or updating with a new endpoint configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.endpointConfigName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe production variant summary for a deployment when an endpoint is creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor updating with the CreateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor UpdateEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateEndpoint.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eoperations. Describes the VariantStatus , weight and capacity for a production\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003evariant associated with an endpoint.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].currentWeight\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eGets the Amazon EC2 Container Registry path of the docker image of the model\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you used the registry/repository[:tag] form to specify the image path\nof the primary container when you created the model hosted in this ProductionVariant,\nthe path resolves to a path of the form registry/repository[@digest]. A digest\nis a hash value that identifies a specific version of an image. For information\nabout Amazon ECR paths, see Pulling an Image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html)\nin the Amazon ECR User Guide. || \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].resolutionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].resolvedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].deployedImages.[].specifiedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].desiredWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts. |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the status of the production variant. || \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.productionVariants.[].variantStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingDeploymentSummary.startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of ProductionVariantSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariantSummary.html)\u003cbr/\u003eobjects, one for each model hosted behind this endpoint. |\n| \u003cstrong\u003eproductionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes weight and capacities for a production variant associated with\nan endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities\nAPI and the endpoint status is Updating, you get different desired and current\nvalues. || \u003cstrong\u003eproductionVariants.[].currentInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].currentWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eGets the Amazon EC2 Container Registry path of the docker image of the model\nthat is hosted in this ProductionVariant (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ProductionVariant.html).\u003c/p\u003e\n\u003cp\u003eIf you used the registry/repository[:tag] form to specify the image path\nof the primary container when you created the model hosted in this ProductionVariant,\nthe path resolves to a path of the form registry/repository[@digest]. A digest\nis a hash value that identifies a specific version of an image. For information\nabout Amazon ECR paths, see Pulling an Image (https://docs.aws.amazon.com/AmazonECR/latest/userguide/docker-pull-ecr-image.html)\nin the Amazon ECR User Guide. || \u003cstrong\u003eproductionVariants.[].deployedImages.[].resolutionTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[].resolvedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].deployedImages.[].specifiedImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant. |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredServerlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].desiredWeight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic. |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts. |\n| \u003cstrong\u003eproductionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the status of the production variant. || \u003cstrong\u003eproductionVariants.[].variantStatus.[].startTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproductionVariants.[].variantStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n'}).add({id:93,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/endpointconfig/",title:"EndpointConfig",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#EndpointConfig"\u003esagemaker-controller/apis/v1alpha1#EndpointConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEndpointConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpointconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eendpointconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003easyncInferenceConfig: \n clientConfig: \n maxConcurrentInvocationsPerInstance: integer\n outputConfig: \n kmsKeyID: string\n notificationConfig: \n errorTopic: string\n includeInferenceResponseIn:\n - string\n successTopic: string\n s3FailurePath: string\n s3OutputPath: string\ndataCaptureConfig: \n captureContentTypeHeader: \n csvContentTypes:\n - string\n jsonContentTypes:\n - string\n captureOptions:\n - captureMode: string\n destinationS3URI: string\n enableCapture: boolean\n initialSamplingPercentage: integer\n kmsKeyID: string\nenableNetworkIsolation: boolean\nendpointConfigName: string\nexecutionRoleARN: string\nkmsKeyID: string\nproductionVariants:\n- acceleratorType: string\n containerStartupHealthCheckTimeoutInSeconds: integer\n coreDumpConfig: \n destinationS3URI: string\n kmsKeyID: string\n enableSSMAccess: boolean\n initialInstanceCount: integer\n initialVariantWeight: number\n instanceType: string\n managedInstanceScaling: \n maxInstanceCount: integer\n minInstanceCount: integer\n status: string\n modelDataDownloadTimeoutInSeconds: integer\n modelName: string\n routingConfig: \n routingStrategy: string\n serverlessConfig: \n maxConcurrency: integer\n memorySizeInMB: integer\n provisionedConcurrency: integer\n variantName: string\n volumeSizeInGB: integer\ntags:\n- key: string\n value: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configuration for how an endpoint performs asynchronous inference.\u003cbr/\u003eThis is a required field in order for your Endpoint to be invoked using InvokeEndpointAsync\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpointAsync.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.clientConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the behavior of the client used by SageMaker to interact with\u003cbr/\u003ethe model container during asynchronous inference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.clientConfig.maxConcurrentInvocationsPerInstance\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for asynchronous inference invocation outputs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the configuration for notifications of inference results for asynchronous\u003cbr/\u003einference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.errorTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.notificationConfig.includeInferenceResponseIn.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.s3FailurePath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003easyncInferenceConfig.outputConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration to control how SageMaker captures inference data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration specifying how to treat different headers. If no headers are\u003cbr/\u003especified Amazon SageMaker will by default base64 encode when capturing the\u003cbr/\u003edata.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.csvContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.csvContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureContentTypeHeader.jsonContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.captureOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies data Model Monitor will capture.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.destinationS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.enableCapture\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.initialSamplingPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataCaptureConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSets whether all model containers deployed to the endpoint are isolated.\u003cbr/\u003eIf they are, no inbound or outbound network calls can be made to or from\u003cbr/\u003ethe model containers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the endpoint configuration. You specify this name in a CreateEndpoint\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateEndpoint.html)\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume\u003cbr/\u003eto perform actions on your behalf. For more information, see SageMaker Roles\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to Amazon SageMaker, the caller of this action\u003cbr/\u003emust have the iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service\u003cbr/\u003ekey that SageMaker uses to encrypt data on the storage volume attached to\u003cbr/\u003ethe ML compute instance that hosts the endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KmsKeyId can be any of the following formats:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias name: alias/ExampleAlias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KMS key policy must grant permission to the IAM role that you specify\u003cbr/\u003ein your CreateEndpoint, UpdateEndpoint requests. For more information, refer\u003cbr/\u003eto the Amazon Web Services Key Management Service section Using Key Policies\u003cbr/\u003ein Amazon Web Services KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCertain Nitro-based instances include local storage, dependent on the instance\u003cbr/\u003etype. Local storage volumes are encrypted using a hardware module on the\u003cbr/\u003einstance. You can\u0026rsquo;t request a KmsKeyId when using an instance type with local\u003cbr/\u003estorage. If any of the models that you specify in the ProductionVariants\u003cbr/\u003eparameter use nitro-based instances with local storage, do not specify a\u003cbr/\u003evalue for the KmsKeyId parameter. If you specify a value for KmsKeyId when\u003cbr/\u003eusing any nitro-based instances with local storage, the call to CreateEndpointConfig\u003cbr/\u003efails.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a list of instance types that support local instance storage, see Instance\u003cbr/\u003eStore Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#instance-store-volumes).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about local instance storage encryption, see SSD Instance\u003cbr/\u003eStore Volumes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ssd-instance-store.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of ProductionVariant objects, one for each model that you want to\u003cbr/\u003ehost at this endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies a model that you want to host and the resources chosen to deploy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor hosting it. If you are deploying multiple models, tell SageMaker how\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto distribute traffic among the models by specifying variant weights. For\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emore information on production variants, check Production variants (https://docs.aws.amazon.com/sagemaker/latest/dg/model-ab-testing.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].containerStartupHealthCheckTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configuration for a core dump from the model container when the\u003cbr/\u003eprocess crashes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig.destinationS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].coreDumpConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].enableSSMAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].initialInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].initialVariantWeight\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control the range in the number of instances that the endpoint\u003cbr/\u003eprovisions as it scales up or down to accommodate traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.maxInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.minInstanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].managedInstanceScaling.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].modelDataDownloadTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].modelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].routingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that control how the endpoint routes incoming traffic to the instances\u003cbr/\u003ethat the endpoint hosts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].routingConfig.routingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the serverless configuration for an endpoint variant.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.maxConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.memorySizeInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].serverlessConfig.provisionedConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].variantName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductionVariants.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:94,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/eventbus/",title:"EventBus",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#EventBus"\u003eeventbridge-controller/apis/v1alpha1#EventBus\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventBus\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventBusList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventbuses\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventbus\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn event bus receives events from a source, uses rules to evaluate them,\napplies any configured input transformation, and routes them to the appropriate\ntarget(s). Your account\u0026rsquo;s default event bus receives events from Amazon Web\nServices services. A custom event bus can receive events from your custom\napplications and services. A partner event bus receives events from an event\nsource created by an SaaS partner. These events come from the partners services\nor applications.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eeventSourceName: string\nname: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf you are creating a partner event bus, this specifies the partner event\u003cbr/\u003esource that the new event bus will be matched with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCustom event bus names can\u0026rsquo;t contain the / character, but you can use the\u003cbr/\u003e/ character in partner event bus names. In addition, for partner event buses,\u003cbr/\u003ethe name must exactly match the name of the partner event source that this\u003cbr/\u003eevent bus is matched to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t use the name default for a custom event bus, as this name is already\u003cbr/\u003eused for your account\u0026rsquo;s default event bus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to associate with the event bus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erules and event buses support tagging.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:95,href:"https://aws-controllers-k8s.github.io/community/reference/cloudtrail/v1alpha1/eventdatastore/",title:"EventDataStore",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudtrail.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudtrail-controller/apis/v1alpha1#EventDataStore"\u003ecloudtrail-controller/apis/v1alpha1#EventDataStore\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventDataStore\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventDataStoreList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventdatastores\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventdatastore\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA storage lake of event data against which you can run complex SQL-based\nqueries. An event data store can include events that you have logged on your\naccount from the last 90 to 2555 days (about three months to up to seven\nyears). To select events for an event data store, use advanced event selectors\n(https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eadvancedEventSelectors:\n fieldSelectors:\n endsWith:\n - string\n equals:\n - string\n field: string\n notEndsWith:\n - string\n notEquals:\n - string\n notStartsWith:\n - string\n startsWith:\n - string\n name: string\nmultiRegionEnabled: boolean\nname: string\norganizationEnabled: boolean\nretentionPeriod: integer\ntags:\n- key: string\n value: string\nterminationProtectionEnabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedEventSelectors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe advanced event selectors to use to select the events for the data store.\u003cbr/\u003eFor more information about how to use advanced event selectors, see Log events\u003cbr/\u003eby using advanced event selectors (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced)\u003cbr/\u003ein the CloudTrail User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadvancedEventSelectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdvanced event selectors let you create fine-grained selectors for the following\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eCloudTrail event record fields. They help you control costs by logging only\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethose events that are important to you. For more information about advanced\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eevent selectors, see Logging data events for trails (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the CloudTrail User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003ereadOnly\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventSource\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventName\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eeventCategory\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eresources.type\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eresources.ARN\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eYou cannot apply both event selectors and advanced event selectors to a trail. || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single selector statement in an advanced event selector. || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].endsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].endsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].equals\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].equals.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].field\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEndsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEndsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEquals\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notEquals.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notStartsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].notStartsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].startsWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eadvancedEventSelectors.[].fieldSelectors.[].startsWith.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eadvancedEventSelectors.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emultiRegionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the event data store includes events from all regions,\u003cbr/\u003eor only from the region in which the event data store is created. |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the event data store. |\n| \u003cstrong\u003eorganizationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether an event data store collects events logged for an organization\u003cbr/\u003ein Organizations. |\n| \u003cstrong\u003eretentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe retention period of the event data store, in days. You can set a retention\u003cbr/\u003eperiod of up to 2555 days, the equivalent of seven years. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource such as a CloudTrail trail. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eterminationProtectionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether termination protection is enabled for the event data store.\u003cbr/\u003eIf termination protection is enabled, you cannot delete the event data store\u003cbr/\u003euntil termination protection is disabled. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedTimestamp: string\nstatus: string\nupdatedTimestamp: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that shows when the event data store was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of event data store creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdatedTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that shows when an event data store was updated, if applicable.\u003cbr/\u003eUpdatedTimestamp is always either the same or newer than the time shown in\u003cbr/\u003eCreatedTimestamp.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:96,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/eventsourcemapping/",title:"EventSourceMapping",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#EventSourceMapping"\u003elambda-controller/apis/v1alpha1#EventSourceMapping\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventSourceMapping\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eEventSourceMappingList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventsourcemappings\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eeventsourcemapping\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamazonManagedKafkaEventSourceConfig: \n consumerGroupID: string\nbatchSize: integer\nbisectBatchOnFunctionError: boolean\ndestinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\nenabled: boolean\neventSourceARN: string\neventSourceRef: \n from: \n name: string\nfilterCriteria: \n filters:\n - pattern: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nfunctionResponseTypes:\n- string\nmaximumBatchingWindowInSeconds: integer\nmaximumRecordAgeInSeconds: integer\nmaximumRetryAttempts: integer\nparallelizationFactor: integer\nqueueRefs:\n from: \n name: string\nqueues:\n- string\nscalingConfig: \n maximumConcurrency: integer\nselfManagedEventSource: \n endpoints: {}\nselfManagedKafkaEventSourceConfig: \n consumerGroupID: string\nsourceAccessConfigurations:\n- type_: string\n uRI: string\nstartingPosition: string\nstartingPositionTimestamp: string\ntopics:\n- string\ntumblingWindowInSeconds: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonManagedKafkaEventSourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecific configuration settings for an Amazon Managed Streaming for Apache\u003cbr/\u003eKafka (Amazon MSK) event source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonManagedKafkaEventSourceConfig.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebatchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of records in each batch that Lambda pulls from your stream\u003cbr/\u003eor queue and sends to your function. Lambda passes all of the records in\u003cbr/\u003ethe batch to the function in a single call, up to the payload limit for synchronous\u003cbr/\u003einvocation (6 MB).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Kinesis – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon DynamoDB Streams – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Simple Queue Service – Default 10. For standard queues the\u003cbr/\u003e max is 10,000. For FIFO queues the max is 10.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Managed Streaming for Apache Kafka – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Self-managed Apache Kafka – Default 100. Max 10,000.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MQ (ActiveMQ and RabbitMQ) – Default 100. Max 10,000.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebisectBatchOnFunctionError\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e(Streams only) If the function returns an error, split the batch in two and\u003cbr/\u003eretry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Streams only) An Amazon SQS queue or Amazon SNS topic destination for discarded\u003cbr/\u003erecords.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhen true, the event source mapping is active. When false, Lambda pauses\u003cbr/\u003epolling and invocation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: True\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the event source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Kinesis – The ARN of the data stream or a stream consumer.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon DynamoDB Streams – The ARN of the stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Simple Queue Service – The ARN of the queue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Managed Streaming for Apache Kafka – The ARN of the cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MQ – The ARN of the broker.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventSourceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that defines the filter criteria that determine whether Lambda\u003cbr/\u003eshould process an event. For more information, see Lambda event filtering\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria.filters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterCriteria.filters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure within a FilterCriteria object that defines an event filtering\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epattern.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Version or Alias ARN – arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it\u0026rsquo;s limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionResponseTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Streams and Amazon SQS) A list of current response type enums applied to\u003cbr/\u003ethe event source mapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionResponseTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) Discard records older than the specified age. The default\u003cbr/\u003evalue is infinite (-1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) Discard records after the specified number of retries. The\u003cbr/\u003edefault value is infinite (-1). When set to infinite (-1), failed records\u003cbr/\u003eare retried until the record expires.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e(Streams only) The number of batches to process from each shard concurrently.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **queueRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003equeueRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003equeues\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(MQ) The name of the Amazon MQ broker destination queue to consume. |\n| \u003cstrong\u003equeues.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003escalingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Amazon SQS only) The scaling configuration for the event source. For more\u003cbr/\u003einformation, see Configuring maximum concurrency for Amazon SQS event sources\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). |\n| \u003cstrong\u003escalingConfig.maximumConcurrency\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eselfManagedEventSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe self-managed Apache Kafka cluster to receive records from. |\n| \u003cstrong\u003eselfManagedEventSource.endpoints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eselfManagedKafkaEventSourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecific configuration settings for a self-managed Apache Kafka event source. |\n| \u003cstrong\u003eselfManagedKafkaEventSourceConfig.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esourceAccessConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of authentication protocols or VPC components required to secure\u003cbr/\u003eyour event source. |\n| \u003cstrong\u003esourceAccessConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTo secure and define access to your event source, you can specify the authentication\nprotocol, VPC components, or virtual host. || **sourceAccessConfigurations.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **sourceAccessConfigurations.[].uRI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **startingPosition**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe position in a stream from which to start reading. Required for Amazon\u003cbr/\u003eKinesis, Amazon DynamoDB, and Amazon MSK Streams sources. AT_TIMESTAMP is\u003cbr/\u003esupported only for Amazon Kinesis streams. |\n| **startingPositionTimestamp**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eWith StartingPosition set to AT_TIMESTAMP, the time from which to start reading. |\n| **topics**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eThe name of the Kafka topic. |\n| **topics.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **tumblingWindowInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e(Streams only) The duration in seconds of a processing window. The range\u003cbr/\u003eis between 1 second and 900 seconds. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfunctionARN: string\nlastModified: string\nlastProcessingResult: string\nstate: string\nstateTransitionReason: string\nuuid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date that the event source mapping was last updated or that its state\u003cbr/\u003echanged.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastProcessingResult\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe result of the last Lambda invocation of your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the event source mapping. It can be one of the following: Creating,\u003cbr/\u003eEnabling, Enabled, Disabling, Disabled, Updating, or Deleting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateTransitionReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether a user or Lambda made the last change to the event source\u003cbr/\u003emapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euuid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the event source mapping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:97,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/fargateprofile/",title:"FargateProfile",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#FargateProfile"\u003eeks-controller/apis/v1alpha1#FargateProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFargateProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFargateProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efargateprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efargateprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Fargate profile.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nname: string\npodExecutionRoleARN: string\npodExecutionRoleRef: \n from: \n name: string\nselectors:\n labels: {}\n namespace: string\nsubnetRefs:\n from: \n name: string\nsubnets:\n- string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Fargate profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Pod execution role to use for a Pod\u003cbr/\u003ethat matches the selectors in the Fargate profile. The Pod execution role\u003cbr/\u003eallows Fargate infrastructure to register with your cluster as a node, and\u003cbr/\u003eit provides read access to Amazon ECR image repositories. For more information,\u003cbr/\u003esee Pod execution role (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epodExecutionRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe selectors to match for a Pod to use this Fargate profile. Each selector\u003cbr/\u003emust have an associated Kubernetes namespace. Optionally, you can also specify\u003cbr/\u003elabels for a namespace. You may specify up to five selectors in a Fargate\u003cbr/\u003eprofile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing an Fargate profile selector.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectors.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IDs of subnets to launch a Pod into. A Pod running on Fargate isn\u0026rsquo;t assigned\u003cbr/\u003ea public IP address, so only private subnets (with no direct route to an\u003cbr/\u003eInternet Gateway) are accepted for this parameter. |\n| \u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the Fargate profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:98,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/featuregroup/",title:"FeatureGroup",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#FeatureGroup"\u003esagemaker-controller/apis/v1alpha1#FeatureGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFeatureGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFeatureGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efeaturegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efeaturegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon SageMaker Feature Store stores features in a collection called Feature\nGroup. A Feature Group can be visualized as a table which has rows, with\na unique identifier for each row where each column in the table is a feature.\nIn principle, a Feature Group is composed of features and values per features.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventTimeFeatureName: string\nfeatureDefinitions:\n collectionConfig: \n vectorConfig: \n dimension: integer\n collectionType: string\n featureName: string\n featureType: string\nfeatureGroupName: string\nofflineStoreConfig: \n dataCatalogConfig: \n catalog: string\n database: string\n tableName: string\n disableGlueTableCreation: boolean\n s3StorageConfig: \n kmsKeyID: string\n resolvedOutputS3URI: string\n s3URI: string\nonlineStoreConfig: \n enableOnlineStore: boolean\n securityConfig: \n kmsKeyID: string\n storageType: string\n ttlDuration: \n unit: string\n value: integer\nrecordIdentifierFeatureName: string\nroleARN: string\ntags:\n- key: string\n value: string\nthroughputConfig: \n provisionedReadCapacityUnits: integer\n provisionedWriteCapacityUnits: integer\n throughputMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA free-form description of a FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventTimeFeatureName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the feature that stores the EventTime of a Record in a FeatureGroup.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn EventTime is a point in time when a new event occurs that corresponds\u003cbr/\u003eto the creation or update of a Record in a FeatureGroup. All Records in the\u003cbr/\u003eFeatureGroup must have a corresponding EventTime.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn EventTime can be a String or Fractional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Fractional: EventTime feature values must be a Unix timestamp in seconds.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * String: EventTime feature values must be an ISO-8601 string in the format.\u003cbr/\u003e The following formats are supported yyyy-MM-dd\u0026rsquo;T\u0026rsquo;HH:mm:ssZ and yyyy-MM-dd\u0026rsquo;T\u0026rsquo;HH:mm:ss.SSSZ\u003cbr/\u003e where yyyy, MM, and dd represent the year, month, and day respectively\u003cbr/\u003e and HH, mm, ss, and if applicable, SSS represent the hour, month, second\u003cbr/\u003e and milliseconds respsectively. \u0026lsquo;T\u0026rsquo; and Z are constants.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Feature names and types. Name and Type is compulsory per Feature.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid feature FeatureTypes are Integral, Fractional and String.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFeatureNames cannot be any of the following: is_deleted, write_time, api_invocation_time\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create up to 2,500 FeatureDefinitions per FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of features. You must include FeatureName and FeatureType. Valid feature\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eFeatureTypes are Integral, Fractional and String.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionConfig.vectorConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for your vector collection type.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionConfig.vectorConfig.dimension\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].collectionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].featureName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureDefinitions.[].featureType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the FeatureGroup. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. The name:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must start and end with an alphanumeric character.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can only contain alphanumeric character and hyphens. Spaces are not\u003cbr/\u003e allowed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUse this to configure an OfflineFeatureStore. This parameter allows you to\u003cbr/\u003especify:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The Amazon Simple Storage Service (Amazon S3) location of an OfflineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A configuration for an Amazon Web Services Glue or Amazon Web Services\u003cbr/\u003e Hive data catalog.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * An KMS encryption key to encrypt the Amazon S3 location used for OfflineStore.\u003cbr/\u003e If KMS encryption key is not specified, by default we encrypt all data\u003cbr/\u003e at rest using Amazon Web Services KMS key. By defining your bucket-level\u003cbr/\u003e key (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-key.html)\u003cbr/\u003e for SSE, you can reduce Amazon Web Services KMS requests costs by up to\u003cbr/\u003e 99 percent.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Format for the offline store table. Supported formats are Glue (Default)\u003cbr/\u003e and Apache Iceberg (https://iceberg.apache.org/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn more about this parameter, see OfflineStoreConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OfflineStoreConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe meta data of the Glue table which serves as data catalog for the OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.catalog\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.dataCatalogConfig.tableName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.disableGlueTableCreation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Amazon Simple Storage (Amazon S3) location and and security configuration\u003cbr/\u003efor OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.resolvedOutputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eofflineStoreConfig.s3StorageConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eYou can turn the OnlineStore on or off by specifying True for the EnableOnlineStore\u003cbr/\u003eflag in OnlineStoreConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can also include an Amazon Web Services KMS key ID (KMSKeyId) for at-rest\u003cbr/\u003eencryption of the OnlineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is False.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.enableOnlineStore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.securityConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe security configuration for OnlineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.securityConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.storageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTime to live duration, where the record is hard deleted after the expiration\u003cbr/\u003etime is reached; ExpiresAt = EventTime + TtlDuration. For information on\u003cbr/\u003eHardDelete, see the DeleteRecord (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_feature_store_DeleteRecord.html)\u003cbr/\u003eAPI in the Amazon SageMaker API Reference guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration.unit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonlineStoreConfig.ttlDuration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erecordIdentifierFeatureName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Feature whose value uniquely identifies a Record defined\u003cbr/\u003ein the FeatureStore. Only the latest record per identifier value will be\u003cbr/\u003estored in the OnlineStore. RecordIdentifierFeatureName must be one of feature\u003cbr/\u003edefinitions\' names.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou use the RecordIdentifierFeatureName to access data in a FeatureStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis name:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Must start and end with an alphanumeric character.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Can only contains alphanumeric characters, hyphens, underscores. Spaces\u003cbr/\u003e are not allowed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM execution role used to persist\u003cbr/\u003edata into the OfflineStore if an OfflineStoreConfig is provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags used to identify Features in each FeatureGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eUsed to set feature group throughput configuration. There are two modes:\u003cbr/\u003eON_DEMAND and PROVISIONED. With on-demand mode, you are charged for data\u003cbr/\u003ereads and writes that your application performs on your feature group. You\u003cbr/\u003edo not need to specify read and write throughput because Feature Store accommodates\u003cbr/\u003eyour workloads as they ramp up and down. You can switch a feature group to\u003cbr/\u003eon-demand only once in a 24 hour period. With provisioned throughput mode,\u003cbr/\u003eyou specify the read and write capacity per second that you expect your application\u003cbr/\u003eto require, and you are billed based on those limits. Exceeding provisioned\u003cbr/\u003ethroughput will result in your requests being throttled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote: PROVISIONED throughput mode is supported only for feature groups that\u003cbr/\u003eare offline-only, or use the Standard (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_OnlineStoreConfig.html#sagemaker-Type-OnlineStoreConfig-StorageType)\u003cbr/\u003etier online store. |\n| \u003cstrong\u003ethroughputConfig.provisionedReadCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig.provisionedWriteCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputConfig.throughputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nfeatureGroupStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason that the FeatureGroup failed to be replicated in the OfflineStore.\u003cbr/\u003eThis is failure can occur because:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The FeatureGroup could not be created in the OfflineStore.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The FeatureGroup could not be deleted from the OfflineStore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efeatureGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the feature group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:99,href:"https://aws-controllers-k8s.github.io/community/reference/common/v1alpha1/fieldexport/",title:"FieldExport",description:null,content:'\u003cp\u003e\u003ccode\u003eservices.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1#FieldExport"\u003eruntime/apis/core/v1alpha1#FieldExport\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFieldExport\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFieldExportList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efieldexports\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efieldexport\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efrom: \n path: string\n resource: \n group: string\n kind: string\n name: string\nto: \n key: string\n kind: string\n name: string\n namespace: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eResourceFieldSelector provides the values necessary to identify an individual\u003cbr/\u003efield on an individual K8s resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.path\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNamespacedResource provides all the values necessary to identify an ACK\u003cbr/\u003eresource of a given type (within the same namespace as the custom resource\u003cbr/\u003econtaining this type).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.group\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efrom.resource.name\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFieldExportTarget provides the values necessary to identify the\u003cbr/\u003eoutput path for a field export.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey overrides the default value (\u003ccode\u003e\u0026lt;namespace\u0026gt;.\u0026lt;FieldExport-resource-name\u0026gt;\u003c/code\u003e) for the FieldExport target\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.kind\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFieldExportOutputType represents all types that can be produced by a field\u003cbr/\u003eexport operation\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.name\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eto.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eNamespace is marked as optional, so we cannot compose \u003ccode\u003eNamespacedName\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various\u003cbr/\u003erecoverable states of the field CR\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:100,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/filesystem/",title:"FileSystem",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#FileSystem"\u003eefs-controller/apis/v1alpha1#FileSystem\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFileSystem\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFileSystemList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efilesystems\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efilesystem\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eavailabilityZoneName: string\nbackup: boolean\nbackupPolicy: \n status: string\nencrypted: boolean\nfileSystemProtection: \n replicationOverwriteProtection: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nlifecyclePolicies:\n- transitionToArchive: string\n transitionToIA: string\n transitionToPrimaryStorageClass: string\nperformanceMode: string\npolicy: string\nprovisionedThroughputInMiBps: number\ntags:\n- key: string\n value: string\nthroughputMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUsed to create a One Zone file system. It specifies the Amazon Web Services\u003cbr/\u003eAvailability Zone in which to create the file system. Use the format us-east-1a\u003cbr/\u003eto specify the Availability Zone. For more information about One Zone file\u003cbr/\u003esystems, see Using EFS storage classes (https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOne Zone file systems are not available in all Availability Zones in Amazon\u003cbr/\u003eWeb Services Regions where Amazon EFS is available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether automatic backups are enabled on the file system that you\u003cbr/\u003eare creating. Set the value to true to enable automatic backups. If you are\u003cbr/\u003ecreating a One Zone file system, automatic backups are enabled by default.\u003cbr/\u003eFor more information, see Automatic backups (https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is false. However, if you specify an AvailabilityZoneName, the default\u003cbr/\u003eis true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBackup is not available in all Amazon Web Services Regions where Amazon EFS\u003cbr/\u003eis available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe backup policy included in the PutBackupPolicy request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebackupPolicy.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA Boolean value that, if true, creates an encrypted file system. When creating\u003cbr/\u003ean encrypted file system, you have the option of specifying an existing Key\u003cbr/\u003eManagement Service key (KMS key). If you don\u0026rsquo;t specify a KMS key, then the\u003cbr/\u003edefault KMS key for Amazon EFS, /aws/elasticfilesystem, is used to protect\u003cbr/\u003ethe encrypted file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemProtection.replicationOverwriteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key that you want to use to protect the encrypted file\u003cbr/\u003esystem. This parameter is required only if you want to use a non-default\u003cbr/\u003eKMS key. If this parameter is not specified, the default KMS key for Amazon\u003cbr/\u003eEFS is used. You can specify a KMS key ID using the following formats:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key alias - A previously created display name for a key, for example\u003cbr/\u003e alias/projectKey1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use KmsKeyId, you must set the CreateFileSystemRequest$Encrypted parameter\u003cbr/\u003eto true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEFS accepts only symmetric KMS keys. You cannot use asymmetric KMS keys with\u003cbr/\u003eAmazon EFS file systems.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of LifecyclePolicy objects that define the file system\u0026rsquo;s LifecycleConfiguration\u003cbr/\u003eobject. A LifecycleConfiguration object informs EFS Lifecycle management\u003cbr/\u003eof the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToIA – When to move files in the file system from primary\u003cbr/\u003e storage (Standard storage class) into the Infrequent Access (IA) storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToArchive – When to move files in the file system from their\u003cbr/\u003e current storage class (either IA or Standard storage) into the Archive\u003cbr/\u003e storage. File systems cannot transition into Archive storage before transitioning\u003cbr/\u003e into IA storage. Therefore, TransitionToArchive must either not be set\u003cbr/\u003e or must be later than TransitionToIA. The Archive storage class is available\u003cbr/\u003e only for file systems that use the Elastic Throughput mode and the General\u003cbr/\u003e Purpose Performance mode.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TransitionToPrimaryStorageClass – Whether to move files in the file\u003cbr/\u003e system back to primary storage (Standard storage class) after they are\u003cbr/\u003e accessed in IA or Archive storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration\u003cbr/\u003eAPI action, Amazon EFS requires that each LifecyclePolicy object have only\u003cbr/\u003ea single transition. This means that in a request body, LifecyclePolicies\u003cbr/\u003emust be structured as an array of LifecyclePolicy objects, one object for\u003cbr/\u003eeach storage transition. See the example requests in the following section\u003cbr/\u003efor more information.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a policy used by Lifecycle management that specifies when to transition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efiles into and out of storage classes. For more information, see Managing\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system storage (https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eWhen using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration\nAPI action, Amazon EFS requires that each LifecyclePolicy object have only\na single transition. This means that in a request body, LifecyclePolicies\nmust be structured as an array of LifecyclePolicy objects, one object for\neach transition. For more information, see the request examples in PutLifecycleConfiguration. || \u003cstrong\u003elifecyclePolicies.[].transitionToArchive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecyclePolicies.[].transitionToIA\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elifecyclePolicies.[].transitionToPrimaryStorageClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eperformanceMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Performance mode of the file system. We recommend generalPurpose performance\u003cbr/\u003emode for all file systems. File systems using the maxIO performance mode\u003cbr/\u003ecan scale to higher levels of aggregate throughput and operations per second\u003cbr/\u003ewith a tradeoff of slightly higher latencies for most file operations. The\u003cbr/\u003eperformance mode can\u0026rsquo;t be changed after the file system has been created.\u003cbr/\u003eThe maxIO mode is not supported on One Zone file systems.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDue to the higher per-operation latencies with Max I/O, we recommend using\u003cbr/\u003eGeneral Purpose performance mode for all file systems.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is generalPurpose. |\n| \u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe FileSystemPolicy that you\u0026rsquo;re creating. Accepts a JSON formatted policy\u003cbr/\u003edefinition. EFS file system policies have a 20,000 character limit. To find\u003cbr/\u003eout more about the elements that make up a file system policy, see EFS Resource-based\u003cbr/\u003ePolicies (https://docs.aws.amazon.com/efs/latest/ug/access-control-overview.html#access-control-manage-access-intro-resource-policies). |\n| \u003cstrong\u003eprovisionedThroughputInMiBps\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003eThe throughput, measured in mebibytes per second (MiBps), that you want to\u003cbr/\u003eprovision for a file system that you\u0026rsquo;re creating. Required if ThroughputMode\u003cbr/\u003eis set to provisioned. Valid values are 1-3414 MiBps, with the upper limit\u003cbr/\u003edepending on Region. To increase this limit, contact Amazon Web Services\u003cbr/\u003eSupport. For more information, see Amazon EFS quotas that you can increase\u003cbr/\u003e(https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the\u003cbr/\u003eAmazon EFS User Guide. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eUse to create one or more tags associated with the file system. Each tag\u003cbr/\u003eis a user-defined key-value pair. Name your file system on creation by including\u003cbr/\u003ea \u0026ldquo;Key\u0026rdquo;:\u0026ldquo;Name\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026quot;{value}\u0026quot; key-value pair. Each key must be unique.\u003cbr/\u003eFor more information, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag is a key-value pair. Allowed characters are letters, white space, and\nnumbers that can be represented in UTF-8, and the following characters:+\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e= . _ : /. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethroughputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the throughput mode for the file system. The mode can be bursting,\u003cbr/\u003eprovisioned, or elastic. If you set ThroughputMode to provisioned, you must\u003cbr/\u003ealso set a value for ProvisionedThroughputInMibps. After you create the file\u003cbr/\u003esystem, you can decrease your file system\u0026rsquo;s Provisioned throughput or change\u003cbr/\u003ebetween the throughput modes, with certain time restrictions. For more information,\u003cbr/\u003esee Specifying throughput with provisioned mode (https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)\u003cbr/\u003ein the Amazon EFS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault is bursting. |\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZoneID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfileSystemID: string\nlifeCycleState: string\nname: string\nnumberOfMountTargets: integer\nownerID: string\nsizeInBytes: \n timestamp: string\n value: integer\n valueInArchive: integer\n valueInIA: integer\n valueInStandard: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique and consistent identifier of the Availability Zone in which the\u003cbr/\u003efile system is located, and is valid only for One Zone file systems. For\u003cbr/\u003eexample, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web\u003cbr/\u003eServices Region, and it has the same location in every Amazon Web Services\u003cbr/\u003eaccount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the file system, assigned by Amazon EFS.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe lifecycle phase of the file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eYou can add tags to a file system, including a Name tag. For more information,\u003cbr/\u003esee CreateFileSystem. If the file system has a Name tag, Amazon EFS returns\u003cbr/\u003ethe value in this field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumberOfMountTargets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current number of mount targets that the file system has. For more information,\u003cbr/\u003esee CreateMountTarget.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account that created the file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe latest known metered size (in bytes) of data stored in the file system,\u003cbr/\u003ein its Value field, and the time at which that size was determined in its\u003cbr/\u003eTimestamp field. The Timestamp value is the integer number of seconds since\u003cbr/\u003e1970-01-01T00:00:00Z. The SizeInBytes value doesn\u0026rsquo;t represent the size of\u003cbr/\u003ea consistent snapshot of the file system, but it is eventually consistent\u003cbr/\u003ewhen there are no writes to the file system. That is, SizeInBytes represents\u003cbr/\u003eactual size only if the file system is not modified for a period longer than\u003cbr/\u003ea couple of hours. Otherwise, the value is not the exact size that the file\u003cbr/\u003esystem was at any point in time.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.timestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInArchive\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInIA\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esizeInBytes.valueInStandard\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:101,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/firewall/",title:"Firewall",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#Firewall"\u003enetworkfirewall-controller/apis/v1alpha1#Firewall\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewall\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewalls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewall\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe firewall defines the configuration settings for an Network Firewall firewall.\nThese settings include the firewall policy, the subnets in your VPC to use\nfor the firewall endpoints, and any tags that are attached to the firewall\nAmazon Web Services resource.\u003c/p\u003e\n\u003cp\u003eThe status of the firewall, for example whether it\u0026rsquo;s ready to filter network\ntraffic, is provided in the corresponding FirewallStatus. You can retrieve\nboth objects by calling DescribeFirewall.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeleteProtection: boolean\ndescription: string\nencryptionConfiguration: \n keyID: string\n type_: string\nfirewallName: string\nfirewallPolicyARN: string\nfirewallPolicyChangeProtection: boolean\nsubnetChangeProtection: boolean\nsubnetMappings:\n- iPAddressType: string\n subnetID: string\ntags:\n- key: string\n value: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating whether it is possible to delete the firewall. A setting\u003cbr/\u003eof TRUE indicates that the firewall is protected against deletion. Use this\u003cbr/\u003esetting to protect against accidentally deleting a firewall that is in use.\u003cbr/\u003eWhen you create a firewall, the operation initializes this flag to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your firewall resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the firewall. You can\u0026rsquo;t change the name of a firewall\u003cbr/\u003eafter you create it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the FirewallPolicy that you want to use\u003cbr/\u003efor the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA setting indicating whether the firewall is protected against a change to\u003cbr/\u003ethe firewall policy association. Use this setting to protect against accidentally\u003cbr/\u003emodifying the firewall policy for a firewall that is in use. When you create\u003cbr/\u003ea firewall, the operation initializes this setting to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA setting indicating whether the firewall is protected against changes to\u003cbr/\u003ethe subnet associations. Use this setting to protect against accidentally\u003cbr/\u003emodifying the subnet associations for a firewall that is in use. When you\u003cbr/\u003ecreate a firewall, the operation initializes this setting to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe public subnets to use for your Network Firewall firewalls. Each subnet\u003cbr/\u003emust belong to a different Availability Zone in the VPC. Network Firewall\u003cbr/\u003ecreates a firewall endpoint in each subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID for a subnet that you want to associate with the firewall. This is\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eused with CreateFirewall and AssociateSubnets. Network Firewall creates an\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einstance of the associated firewall in each subnet that you specify, to filter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etraffic in the subnet\u0026rsquo;s Availability Zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetMappings.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier of the VPC where Network Firewall should create the\u003cbr/\u003efirewall.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t change this setting after you create the firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfirewall: \n deleteProtection: boolean\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n firewallARN: string\n firewallID: string\n firewallName: string\n firewallPolicyARN: string\n firewallPolicyChangeProtection: boolean\n subnetChangeProtection: boolean\n subnetMappings:\n - iPAddressType: string\n subnetID: string\n tags:\n - key: string\n value: string\n vpcID: string\nfirewallStatus: \n capacityUsageSummary: \n cidrs: \n availableCIDRCount: integer\n iPSetReferences: {}\n utilizedCIDRCount: integer\n configurationSyncStateSummary: string\n status: string\n syncStates: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration settings for the firewall. These settings include the firewall\u003cbr/\u003epolicy and the subnets in your VPC to use for the firewall endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.deleteProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**firewall.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.firewallPolicyChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetChangeProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ID for a subnet that you want to associate with the firewall. This is\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eused with CreateFirewall and AssociateSubnets. Network Firewall creates an\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einstance of the associated firewall in each subnet that you specify, to filter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etraffic in the subnet\u0026rsquo;s Availability Zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.subnetMappings.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewall.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetailed information about the current status of a Firewall. You can retrieve\u003cbr/\u003ethis for a firewall by calling DescribeFirewall and providing the firewall\u003cbr/\u003ename and ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe capacity usage summary of the resources used by the ReferenceSets in\u003cbr/\u003ea firewall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSummarizes the CIDR blocks used by the IP set references in a firewall. Network\u003cbr/\u003eFirewall calculates the number of CIDRs by taking an aggregated count of\u003cbr/\u003eall CIDRs used by the IP sets you are referencing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.availableCIDRCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.iPSetReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.capacityUsageSummary.cidrs.utilizedCIDRCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.configurationSyncStateSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallStatus.syncStates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:102,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/firewallpolicy/",title:"FirewallPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#FirewallPolicy"\u003enetworkfirewall-controller/apis/v1alpha1#FirewallPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFirewallPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewallpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efirewallpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe firewall policy defines the behavior of a firewall using a collection\nof stateless and stateful rule groups and other settings. You can use one\nfirewall policy for multiple firewalls.\u003c/p\u003e\n\u003cp\u003eThis, along with FirewallPolicyResponse, define the policy. You can retrieve\nall objects for a firewall policy by calling DescribeFirewallPolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nencryptionConfiguration: \n keyID: string\n type_: string\nfirewallPolicy: \n policyVariables: \n ruleVariables: {}\n statefulDefaultActions:\n - string\n statefulEngineOptions: \n ruleOrder: string\n streamExceptionPolicy: string\n statefulRuleGroupReferences:\n override: \n action: string\n priority: integer\n resourceARN: string\n statelessCustomActions:\n actionDefinition: \n publishMetricAction: \n dimensions:\n - value: string\n actionName: string\n statelessDefaultActions:\n - string\n statelessFragmentDefaultActions:\n - string\n statelessRuleGroupReferences:\n - priority: integer\n resourceARN: string\n tlsInspectionConfigurationARN: string\nfirewallPolicyName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your firewall policy\u003cbr/\u003eresources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe rule groups and policy actions to use in the firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.policyVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains variables that you can use to override default Suricata settings\u003cbr/\u003ein your firewall policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.policyVariables.ruleVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulEngineOptions.ruleOrder\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulEngineOptions.streamExceptionPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifier for a single stateful rule group, used in a firewall policy to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erefer to a rule group.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].override.action\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statefulRuleGroupReferences.[].resourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statelessCustomActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicy.statelessCustomActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn optional, non-standard action to use for stateless packet handling. You\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan define this in addition to the standard action that you must specify.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou define and name the custom actions that you want to be able to use, and\nthen you reference them by name in your actions settings.\u003c/p\u003e\n\u003cp\u003eYou can use custom actions in the following places:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eIn a rule group\u0026rsquo;s StatelessRulesAndCustomActions specification. The\ncustom actions are available for use by name inside the StatelessRulesAndCustomActions\nwhere you define them. You can use them for your stateless rule actions\nto specify what to do with a packet that matches the rule\u0026rsquo;s match attributes.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIn a FirewallPolicy specification, in StatelessCustomActions. The custom\nactions are available for use inside the policy where you define them.\nYou can use them for the policy\u0026rsquo;s default stateless actions settings to\nspecify what to do with packets that don\u0026rsquo;t match any of the policy\u0026rsquo;s stateless\nrules. || \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom action to use in stateless rule actions settings. This is used in\u003cbr/\u003eCustomAction. |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateless inspection criteria that publishes the specified metrics to Amazon\u003cbr/\u003eCloudWatch for the matching packet. This setting defines a CloudWatch dimension\u003cbr/\u003evalue to be published. |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe value to use in an Amazon CloudWatch custom metric dimension. This is\nused in the PublishMetrics CustomAction. A CloudWatch custom metric dimension\nis a name/value pair that\u0026rsquo;s part of the identity of a metric.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eNetwork Firewall sets the dimension name to CustomAction and you provide\nthe dimension value.\u003c/p\u003e\n\u003cp\u003eFor more information about CloudWatch custom metric dimensions, see Publishing\nCustom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions)\nin the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). || \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionDefinition.publishMetricAction.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessCustomActions.[].actionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003efirewallPolicy.statelessFragmentDefaultActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessFragmentDefaultActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifier for a single stateless rule group, used in a firewall policy to\nrefer to the rule group. || \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.statelessRuleGroupReferences.[].resourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicy.tlsInspectionConfigurationARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003efirewallPolicyName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the firewall policy. You can\u0026rsquo;t change the name of\u003cbr/\u003ea firewall policy after you create it. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\npair can be anything you define. Typically, the tag key represents a category\n(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\nthat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\nup to 50 tags to each Amazon Web Services resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfirewallPolicyResponse: \n consumedStatefulRuleCapacity: integer\n consumedStatelessRuleCapacity: integer\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n firewallPolicyARN: string\n firewallPolicyID: string\n firewallPolicyName: string\n firewallPolicyStatus: string\n lastModifiedTime: string\n numberOfAssociations: integer\n tags:\n - key: string\n value: string\nupdateToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe high-level properties of a firewall policy. This, along with the FirewallPolicy,\u003cbr/\u003edefine the policy. You can retrieve all objects for a firewall policy by\u003cbr/\u003ecalling DescribeFirewallPolicy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.consumedStatefulRuleCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.consumedStatelessRuleCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**firewallPolicyResponse.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.firewallPolicyStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.numberOfAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efirewallPolicyResponse.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA token used for optimistic locking. Network Firewall returns a token to\u003cbr/\u003eyour requests that access the firewall policy. The token marks the state\u003cbr/\u003eof the policy resource at the time of the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo make changes to the policy, you provide the token in your request. Network\u003cbr/\u003eFirewall uses the token to ensure that the policy hasn\u0026rsquo;t changed since you\u003cbr/\u003elast retrieved it. If it has changed, the operation fails with an InvalidTokenException.\u003cbr/\u003eIf this happens, retrieve the firewall policy again to get a current copy\u003cbr/\u003eof it with current token. Reapply your changes as needed, then try the operation\u003cbr/\u003eagain using the new token.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:103,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/flowlog/",title:"FlowLog",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#FlowLog"\u003eec2-controller/apis/v1alpha1#FlowLog\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFlowLog\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFlowLogList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eflowlogs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eflowlog\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a flow log.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeliverLogsPermissionARN: string\ndestinationOptions: \n fileFormat: string\n hiveCompatiblePartitions: boolean\n perHourPartition: boolean\nlogDestination: string\nlogDestinationType: string\nlogFormat: string\nlogGroupName: string\nmaxAggregationInterval: integer\nresourceID: string\nresourceType: string\ntags:\n- key: string\n value: string\ntrafficType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliverLogsPermissionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN for the IAM role that permits Amazon EC2 to publish flow logs to\u003cbr/\u003ea CloudWatch Logs log group in your account.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe destination options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.fileFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.hiveCompatiblePartitions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edestinationOptions.perHourPartition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDestination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe destination to which the flow log data is to be published. Flow log data\u003cbr/\u003ecan be published to a CloudWatch Logs log group or an Amazon S3 bucket. The\u003cbr/\u003evalue specified for this parameter depends on the value specified for LogDestinationType.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf LogDestinationType is not specified or cloud-watch-logs, specify the Amazon\u003cbr/\u003eResource Name (ARN) of the CloudWatch Logs log group. For example, to publish\u003cbr/\u003eto a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs.\u003cbr/\u003eAlternatively, use LogGroupName instead.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You\u003cbr/\u003ecan also specify a subfolder in the bucket. To specify a subfolder in the\u003cbr/\u003ebucket, use the following ARN format: bucket_ARN/subfolder_name/. For example,\u003cbr/\u003eto specify a subfolder named my-logs in a bucket named my-bucket, use the\u003cbr/\u003efollowing ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as\u003cbr/\u003ea subfolder name. This is a reserved term.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDestinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of destination to which the flow log data is to be published. Flow\u003cbr/\u003elog data can be published to CloudWatch Logs or Amazon S3. To publish flow\u003cbr/\u003elog data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log\u003cbr/\u003edata to Amazon S3, specify s3.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: cloud-watch-logs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe fields to include in the flow log record, in the order in which they\u003cbr/\u003eshould appear. For a list of available fields, see Flow log records (https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html#flow-log-records).\u003cbr/\u003eIf you omit this parameter, the flow log is created using the default format.\u003cbr/\u003eIf you specify this parameter, you must specify at least one field.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the fields using the ${field-id} format, separated by spaces. For\u003cbr/\u003ethe CLI, surround this parameter value with single quotes on Linux or double\u003cbr/\u003equotes on Windows.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of a new or existing CloudWatch Logs log group where Amazon EC2\u003cbr/\u003epublishes your flow logs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn\u003cbr/\u003eor LogGroupName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxAggregationInterval\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum interval of time during which a flow of packets is captured and\u003cbr/\u003eaggregated into a flow log record. You can specify 60 seconds (1 minute)\u003cbr/\u003eor 600 seconds (10 minutes).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a network interface is attached to a Nitro-based instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances),\u003cbr/\u003ethe aggregation interval is always 60 seconds or less, regardless of the\u003cbr/\u003evalue that you specify.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: 600\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of resource for which to create the flow log. For example, if you\u003cbr/\u003especified a VPC ID for the ResourceId property, specify VPC for this property.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etrafficType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of traffic to log. You can log traffic that the resource accepts\u003cbr/\u003eor rejects, or all traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclientToken: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nflowLogID: string\nunsuccessful:\n error: \n code: string\n message: string\n resourceID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eflowLogID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the flow logs that could not be created successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about items that were not successfully processed in a batch call.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].error.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eunsuccessful.[].resourceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:104,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/function/",title:"Function",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#Function"\u003ecloudfront-controller/apis/v1alpha1#Function\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efunctionCode: string\nfunctionConfig: \n comment: string\n runtime: string\nname: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionCode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function code. For more information about writing a CloudFront function,\u003cbr/\u003esee Writing function code for CloudFront Functions (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/writing-function-code.html)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information about the function, including an optional comment\u003cbr/\u003eand the function\u0026rsquo;s runtime.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionConfig.runtime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name to identify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nfunctionSummary: \n functionConfig: \n comment: string\n runtime: string\n functionMetadata: \n createdTime: string\n functionARN: string\n lastModifiedTime: string\n stage: string\n name: string\n status: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version identifier for the current version of the CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information and metadata about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains configuration information about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionConfig.runtime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains metadata about a CloudFront function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.createdTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.functionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.functionMetadata.stage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionSummary.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL of the CloudFront function. Use the URL to manage the function with\u003cbr/\u003ethe CloudFront API.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:105,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/function/",title:"Function",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Function"\u003elambda-controller/apis/v1alpha1#Function\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunction\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003earchitectures:\n- string\ncode: \n imageURI: string\n s3Bucket: string\n s3BucketRef: \n from: \n name: string\n s3Key: string\n s3ObjectVersion: string\n zipFile: string\ncodeSigningConfigARN: string\ndeadLetterConfig: \n targetARN: string\ndescription: string\nenvironment: \n variables: {}\nephemeralStorage: \n size: integer\nfileSystemConfigs:\n- arn: string\n localMountPath: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nhandler: string\nimageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nkmsKeyARN: string\nkmsKeyRef: \n from: \n name: string\nlayers:\n- string\nmemorySize: integer\nname: string\npackageType: string\npublish: boolean\nreservedConcurrentExecutions: integer\nrole: string\nroleRef: \n from: \n name: string\nruntime: string\nsnapStart: \n applyOn: string\ntags: {}\ntimeout: integer\ntracingConfig: \n mode: string\nvpcConfig: \n securityGroupIDs:\n - string\n securityGroupRefs:\n from: \n name: string\n subnetIDs:\n - string\n subnetRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe instruction set architecture that the function supports. Enter a string\u003cbr/\u003earray with one of the valid values (arm64 or x86_64). The default value is\u003cbr/\u003ex86_64.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3Bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for S3Bucket\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3BucketRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3Key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.s3ObjectVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecode.zipFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSigningConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eTo enable code signing for this function, specify the ARN of a code-signing\u003cbr/\u003econfiguration. A code-signing configuration includes a set of signing profiles,\u003cbr/\u003ewhich define the trusted publishers for this function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dead-letter queue configuration that specifies the queue or topic where\u003cbr/\u003eLambda sends asynchronous events when they fail processing. For more information,\u003cbr/\u003esee Dead-letter queues (https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig.targetARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnvironment variables that are accessible from function code during execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.variables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe size of the function\u0026rsquo;s /tmp directory in MB. The default value is 512,\u003cbr/\u003ebut can be any whole number between 512 and 10,240 MB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConnection settings for an Amazon EFS file system.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the connection between a Lambda function and an Amazon EFS\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[].localMountPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures options for asynchronous invocation on a function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- DestinationConfig\u003cbr/\u003eA destination for events after they have been sent to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypes of Destinations:\u003cbr/\u003eFunction - The Amazon Resource Name (ARN) of a Lambda function.\u003cbr/\u003eQueue - The ARN of a standard SQS queue.\u003cbr/\u003eTopic - The ARN of a standard SNS topic.\u003cbr/\u003eEvent Bus - The ARN of an Amazon EventBridge event bus.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumEventAgeInSeconds\u003cbr/\u003eThe maximum age of a request that Lambda sends to a function for processing.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e- MaximumRetryAttempts\u003cbr/\u003eThe maximum number of times to retry when the function returns an error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehandler\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the method within your code that Lambda calls to run your function.\u003cbr/\u003eHandler is required if the deployment package is a .zip file archive. The\u003cbr/\u003eformat includes the file name. It can also include namespaces and other qualifiers,\u003cbr/\u003edepending on the runtime. For more information, see Lambda programming model\u003cbr/\u003e(https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer image configuration values (https://docs.aws.amazon.com/lambda/latest/dg/configuration-images.html#configuration-images-settings)\u003cbr/\u003ethat override the values in the container image Dockerfile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the Key Management Service (KMS) key that\u0026rsquo;s used to encrypt your\u003cbr/\u003efunction\u0026rsquo;s environment variables. If it\u0026rsquo;s not provided, Lambda uses a default\u003cbr/\u003eservice key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of function layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html)\u003cbr/\u003eto add to the function\u0026rsquo;s execution environment. Specify each layer by its\u003cbr/\u003eARN, including the version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epackageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of deployment package. Set to Image for container image and set\u003cbr/\u003eto Zip for .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublish\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSet to true to publish the first version of the function during creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereservedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of simultaneous executions to reserve for the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the function\u0026rsquo;s execution role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruntime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the function\u0026rsquo;s runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html).\u003cbr/\u003eRuntime is required if the deployment package is a .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html)\u003cbr/\u003esetting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.applyOn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of tags (https://docs.aws.amazon.com/lambda/latest/dg/tagging.html)\u003cbr/\u003eto apply to the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of time (in seconds) that Lambda allows a function to run before\u003cbr/\u003estopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.\u003cbr/\u003eFor more information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSet Mode to Active to sample and trace a subset of incoming requests with\u003cbr/\u003eX-Ray (https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor network connectivity to Amazon Web Services resources in a VPC, specify\u003cbr/\u003ea list of security groups and subnets in the VPC. When you connect a function\u003cbr/\u003eto a VPC, it can access resources and the internet only through that VPC.\u003cbr/\u003eFor more information, see Configuring a Lambda function to access resources\u003cbr/\u003ein a VPC (https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcConfig.securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcConfig.securityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetIDs |\n| \u003cstrong\u003evpcConfig.subnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **vpcConfig.subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003evpcConfig.subnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncodeSHA256: string\ncodeSize: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nimageConfigResponse: \n error: \n errorCode: string\n message: string\n imageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nlastModified: string\nlastUpdateStatus: string\nlastUpdateStatusReason: string\nlastUpdateStatusReasonCode: string\nlayerStatuses:\n- arn: string\n codeSize: integer\n signingJobARN: string\n signingProfileVersionARN: string\nmasterARN: string\nrevisionID: string\nsigningJobARN: string\nsigningProfileVersionARN: string\nstate: string\nstateReason: string\nstateReasonCode: string\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSHA256\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SHA256 hash of the function\u0026rsquo;s deployment package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe size of the function\u0026rsquo;s deployment package, in bytes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s image configuration values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError response to GetFunctionConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration values that override the container image Dockerfile settings.\u003cbr/\u003eFor more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the function was last updated, in ISO-8601 format\u003cbr/\u003e(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the last update that was performed on the function. This is\u003cbr/\u003efirst set to Successful after function creation completes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].codeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].signingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerStatuses.[].signingProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor Lambda@Edge functions, the ARN of the main function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe latest updated revision of the function or alias.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing profile version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the function. When the state is Inactive, you can reactivate\u003cbr/\u003ethe function by invoking it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the function\u0026rsquo;s current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the function\u0026rsquo;s current state. When the code is Creating,\u003cbr/\u003eyou can\u0026rsquo;t invoke or modify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:106,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/functionurlconfig/",title:"FunctionURLConfig",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#FunctionURLConfig"\u003elambda-controller/apis/v1alpha1#FunctionURLConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionURLConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eFunctionURLConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctionurlconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003efunctionurlconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails about a Lambda function URL.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eauthType: string\ncors: \n allowCredentials: boolean\n allowHeaders:\n - string\n allowMethods:\n - string\n allowOrigins:\n - string\n exposeHeaders:\n - string\n maxAge: integer\nfunctionName: string\nfunctionRef: \n from: \n name: string\nqualifier: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of authentication that your function URL uses. Set to AWS_IAM if\u003cbr/\u003eyou want to restrict access to authenticated IAM users only. Set to NONE\u003cbr/\u003eif you want to bypass IAM authentication to create a public endpoint. For\u003cbr/\u003emore information, see Security and auth model for Lambda function URLs (https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe cross-origin resource sharing (CORS) (https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\u003cbr/\u003esettings for your function URL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowMethods.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.allowOrigins.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecors.exposeHeaders.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name – my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN – arn:aws:lambda:us-west-2:123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN – 123456789012:function:my-function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equalifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe alias name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfunctionARN: string\nfunctionURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe HTTP URL endpoint for your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:107,href:"https://aws-controllers-k8s.github.io/community/reference/rds/v1alpha1/globalcluster/",title:"GlobalCluster",description:null,content:'\u003cp\u003e\u003ccode\u003erds.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/rds-controller/apis/v1alpha1#GlobalCluster"\u003erds-controller/apis/v1alpha1#GlobalCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobalclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobalcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA data type representing an Aurora global database.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edatabaseName: string\ndeletionProtection: boolean\nengine: string\nengineVersion: string\nglobalClusterIdentifier: string\nsourceDBClusterIdentifier: string\nstorageEncrypted: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatabaseName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for your database of up to 64 alphanumeric characters. If you do\u003cbr/\u003enot provide a name, Amazon Aurora will not create a database in the global\u003cbr/\u003edatabase cluster you are creating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe deletion protection setting for the new global database. The global database\u003cbr/\u003ecan\u0026rsquo;t be deleted when deletion protection is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database engine to be used for this DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe engine version of the Aurora global database.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster identifier of the new global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceDBClusterIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) to use as the primary cluster of the global\u003cbr/\u003edatabase. This parameter is optional.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estorageEncrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe storage encryption setting for the new global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailoverState: \n fromDBClusterARN: string\n status: string\n toDBClusterARN: string\nglobalClusterMembers:\n- dbClusterARN: string\n globalWriteForwardingStatus: string\n isWriter: boolean\n readers:\n - string\nglobalClusterResourceID: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data object containing all properties for the current state of an in-process\u003cbr/\u003eor pending failover process for this Aurora global database. This object\u003cbr/\u003eis empty unless the FailoverGlobalCluster API operation has been called on\u003cbr/\u003ethis Aurora global database (GlobalCluster).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.fromDBClusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailoverState.toDBClusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of primary and secondary clusters within the global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA data structure with information about any primary and secondary clusters\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eassociated with an Aurora global database.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].globalWriteForwardingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].isWriter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].readers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalClusterMembers.[].readers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the current state of this global database cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:108,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/globaltable/",title:"GlobalTable",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#GlobalTable"\u003edynamodb-controller/apis/v1alpha1#GlobalTable\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGlobalTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobaltables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eglobaltable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the properties of a global table.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eglobalTableName: string\nreplicationGroup:\n- regionName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalTableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe global table name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroup\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Regions where the global table needs to be created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroup.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a replica.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDateTime: string\nglobalTableStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe creation time of the global table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalTableStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the global table:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The global table is being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - The global table is being updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The global table is being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The global table is ready for use.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:109,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/grant/",title:"Grant",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Grant"\u003ekms-controller/apis/v1alpha1#Grant\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGrant\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGrantList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egrants\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egrant\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econstraints: \n encryptionContextEquals: {}\n encryptionContextSubset: {}\ngrantTokens:\n- string\ngranteePrincipal: string\nkeyID: string\nkeyRef: \n from: \n name: string\nname: string\noperations:\n- string\nretiringPrincipal: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a grant constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS supports the EncryptionContextEquals and EncryptionContextSubset grant\u003cbr/\u003econstraints. Each constraint value can include up to 8 encryption context\u003cbr/\u003epairs. The encryption context value in each constraint cannot exceed 384\u003cbr/\u003echaracters. For information about grant constraints, see Using grant constraints\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/create-grant-overview.html#grant-constraints)\u003cbr/\u003ein the Key Management Service Developer Guide. For more information about\u003cbr/\u003eencryption context, see Encryption context (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe encryption context grant constraints allow the permissions in the grant\u003cbr/\u003eonly when the encryption context in the request matches (EncryptionContextEquals)\u003cbr/\u003eor includes (EncryptionContextSubset) the encryption context specified in\u003cbr/\u003ethis structure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe encryption context grant constraints are supported only on grant operations\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)\u003cbr/\u003ethat include an EncryptionContext parameter, such as cryptographic operations\u003cbr/\u003eon symmetric encryption KMS keys. Grants with grant constraints can include\u003cbr/\u003ethe DescribeKey and RetireGrant operations, but the constraint doesn\u0026rsquo;t apply\u003cbr/\u003eto these operations. If a grant with a grant constraint includes the CreateGrant\u003cbr/\u003eoperation, the constraint requires that any grants created with the CreateGrant\u003cbr/\u003epermission have an equally strict or stricter encryption context constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use an encryption context grant constraint for cryptographic operations\u003cbr/\u003ewith asymmetric KMS keys or HMAC KMS keys. These keys don\u0026rsquo;t support an encryption\u003cbr/\u003econtext.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints.encryptionContextEquals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econstraints.encryptionContextSubset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantTokens\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of grant tokens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a grant token when your permission to call this operation comes from\u003cbr/\u003ea new grant that has not yet achieved eventual consistency. For more information,\u003cbr/\u003esee Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)\u003cbr/\u003eand Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantTokens.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIdentifies the KMS key for the grant. The grant gives principals permission\u003cbr/\u003eto use this KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify the key ID or key ARN of the KMS key. To specify a KMS key in a different\u003cbr/\u003eAmazon Web Services account, you must use the key ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name for the grant. Use this value to prevent the unintended creation\u003cbr/\u003eof duplicate grants when retrying this request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen this value is absent, all CreateGrant requests result in a new grant\u003cbr/\u003ewith a unique GrantId even if all the supplied parameters are identical.\u003cbr/\u003eThis can result in unintended duplicates when you retry the CreateGrant request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen this value is present, you can retry a CreateGrant request with identical\u003cbr/\u003eparameters; if the grant already exists, the original GrantId is returned\u003cbr/\u003ewithout creating a new grant. Note that the returned grant token is unique\u003cbr/\u003ewith every CreateGrant request, even when a duplicate GrantId is returned.\u003cbr/\u003eAll grant tokens for the same grant ID can be used interchangeably.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperations\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of operations that the grant permits.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis list must include only operations that are permitted in a grant. Also,\u003cbr/\u003ethe operation must be supported on the KMS key. For example, you cannot create\u003cbr/\u003ea grant for a symmetric encryption KMS key that allows the Sign operation,\u003cbr/\u003eor a grant for an asymmetric KMS key that allows the GenerateDataKey operation.\u003cbr/\u003eIf you try, KMS returns a ValidationError exception. For details, see Grant\u003cbr/\u003eoperations (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#terms-grant-operations)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ngrantID: string\ngrantToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the grant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egrantToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe grant token.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a grant token when your permission to call this operation comes from\u003cbr/\u003ea new grant that has not yet achieved eventual consistency. For more information,\u003cbr/\u003esee Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)\u003cbr/\u003eand Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:110,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/group/",title:"Group",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Group"\u003eiam-controller/apis/v1alpha1#Group\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003egroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM group entity.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateGroup\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetGroup\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListGroups\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003einlinePolicies: {}\nname: string\npath: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the group to create. Do not include the path in this value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the group. For more information about paths, see IAM identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ngroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the group was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the group. For more information\u003cbr/\u003eabout IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:111,href:"https://aws-controllers-k8s.github.io/community/reference/route53/v1alpha1/hostedzone/",title:"HostedZone",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53-controller/apis/v1alpha1#HostedZone"\u003eroute53-controller/apis/v1alpha1#HostedZone\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHostedZone\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHostedZoneList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehostedzones\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehostedzone\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA complex type that contains general information about the hosted zone.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edelegationSetID: string\nhostedZoneConfig: \n comment: string\n privateZone: boolean\nname: string\ntags:\n- key: string\n value: string\nvpc: \n vpcID: string\n vpcRegion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edelegationSetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf you want to associate a reusable delegation set with this hosted zone,\u003cbr/\u003ethe ID that Amazon Route 53 assigned to the reusable delegation set when\u003cbr/\u003eyou created it. For more information about reusable delegation sets, see\u003cbr/\u003eCreateReusableDelegationSet (https://docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using a reusable delegation set to create a public hosted zone\u003cbr/\u003efor a subdomain, make sure that the parent hosted zone doesn\u0026rsquo;t use one or\u003cbr/\u003emore of the same name servers. If you have overlapping nameservers, the operation\u003cbr/\u003ewill cause a ConflictingDomainsExist error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Optional) A complex type that contains the following optional values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For public and private hosted zones, an optional comment\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For private hosted zones, an optional PrivateZone element\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify a comment or the PrivateZone element, omit HostedZoneConfig\u003cbr/\u003eand the other elements.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostedZoneConfig.privateZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the domain. Specify a fully qualified domain name, for example,\u003cbr/\u003ewww.example.com. The trailing dot is optional; Amazon Route 53 assumes that\u003cbr/\u003ethe domain name is fully qualified. This means that Route 53 treats www.example.com\u003cbr/\u003e(without a trailing dot) and www.example.com. (with a trailing dot) as identical.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating a public hosted zone, this is the name you have registered\u003cbr/\u003ewith your DNS registrar. If your domain name is registered with a registrar\u003cbr/\u003eother than Route 53, change the name servers for your domain to the set of\u003cbr/\u003eNameServers that CreateHostedZone returns in DelegationSet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA complex type that contains a list of the tags that you want to add to the\u003cbr/\u003especified health check or hosted zone and/or the tags that you want to edit\u003cbr/\u003eValue for.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can add a maximum of 10 tags to a health check or a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about a tag that you want to add\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor edit for the specified health check or hosted zone.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e(Private hosted zones only) A complex type that contains information about\u003cbr/\u003ethe Amazon VPC that you\u0026rsquo;re associating with this hosted zone.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can specify only one Amazon VPC when you create a private hosted zone.\u003cbr/\u003eIf you are associating a VPC with a hosted zone with this request, the paramaters\u003cbr/\u003eVPCId and VPCRegion are also required.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone\u003cbr/\u003e(https://docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html)\u003cbr/\u003eafter you create a hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(Private hosted zones only) The ID of an Amazon VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpc.vpcRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncallerReference: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfig: \n comment: string\n privateZone: boolean\nid: string\nlinkedService: \n description: string\n servicePrincipal: string\nresourceRecordSetCount: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecallerReference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe value that you specified for CallerReference when you created the hosted\u003cbr/\u003ezone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that includes the Comment and PrivateZone elements. If you\u003cbr/\u003eomitted the HostedZoneConfig and Comment elements from the request, the Config\u003cbr/\u003eand Comment elements don\u0026rsquo;t appear in the response.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfig.privateZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID that Amazon Route 53 assigned to the hosted zone when you created\u003cbr/\u003eit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIf the hosted zone was created by another service, the service that created\u003cbr/\u003ethe hosted zone. When a hosted zone is created by another service, you can\u0026rsquo;t\u003cbr/\u003eedit or delete it using Route 53.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elinkedService.servicePrincipal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceRecordSetCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of resource record sets in the hosted zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:112,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/hyperparametertuningjob/",title:"HyperParameterTuningJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#HyperParameterTuningJob"\u003esagemaker-controller/apis/v1alpha1#HyperParameterTuningJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHyperParameterTuningJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eHyperParameterTuningJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehyperparametertuningjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ehyperparametertuningjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eautotune: \n mode: string\nhyperParameterTuningJobConfig: \n hyperParameterTuningJobObjective: \n metricName: string\n type_: string\n parameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n resourceLimits: \n maxNumberOfTrainingJobs: integer\n maxParallelTrainingJobs: integer\n strategy: string\n trainingJobEarlyStoppingType: string\n tuningJobCompletionCriteria: \n targetObjectiveMetricValue: number\nhyperParameterTuningJobName: string\ntags:\n- key: string\n value: string\ntrainingJobDefinition: \n algorithmSpecification: \n algorithmName: string\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\n checkpointConfig: \n localPath: string\n s3URI: string\n definitionName: string\n enableInterContainerTrafficEncryption: boolean\n enableManagedSpotTraining: boolean\n enableNetworkIsolation: boolean\n hyperParameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n inputDataConfig:\n - channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\n outputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\n resourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n retryStrategy: \n maximumRetryAttempts: integer\n roleARN: string\n staticHyperParameters: {}\n stoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\n tuningObjective: \n metricName: string\n type_: string\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\ntrainingJobDefinitions:\n algorithmSpecification: \n algorithmName: string\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\n checkpointConfig: \n localPath: string\n s3URI: string\n definitionName: string\n enableInterContainerTrafficEncryption: boolean\n enableManagedSpotTraining: boolean\n enableNetworkIsolation: boolean\n hyperParameterRanges: \n autoParameters:\n - name: string\n valueHint: string\n categoricalParameterRanges:\n - name: string\n values:\n - string\n continuousParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n integerParameterRanges:\n - maxValue: string\n minValue: string\n name: string\n scalingType: string\n inputDataConfig:\n - channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\n outputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\n resourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n retryStrategy: \n maximumRetryAttempts: integer\n roleARN: string\n staticHyperParameters: {}\n stoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\n tuningObjective: \n metricName: string\n type_: string\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nwarmStartConfig: \n parentHyperParameterTuningJobs:\n - hyperParameterTuningJobName: string\n warmStartType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautotune\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures SageMaker Automatic model tuning (AMT) to automatically find optimal\u003cbr/\u003eparameters for the following fields:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ParameterRanges (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-ParameterRanges):\u003cbr/\u003e The names and ranges of parameters that a hyperparameter tuning job can\u003cbr/\u003e optimize.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ResourceLimits (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html):\u003cbr/\u003e The maximum resources that can be used for a training job. These resources\u003cbr/\u003e include the maximum number of training jobs, the maximum runtime of a\u003cbr/\u003e tuning job, and the maximum number of training jobs to run at the same\u003cbr/\u003e time.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TrainingJobEarlyStoppingType (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html#sagemaker-Type-HyperParameterTuningJobConfig-TrainingJobEarlyStoppingType):\u003cbr/\u003e A flag that specifies whether or not to use early stopping for training\u003cbr/\u003e jobs launched by a hyperparameter tuning job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * RetryStrategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-RetryStrategy):\u003cbr/\u003e The number of times to retry a training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Strategy (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html):\u003cbr/\u003e Specifies how hyperparameter tuning chooses the combinations of hyperparameter\u003cbr/\u003e values to use for the training jobs that it launches.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ConvergenceDetected (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ConvergenceDetected.html):\u003cbr/\u003e A flag to indicate that Automatic model tuning (AMT) has detected model\u003cbr/\u003e convergence.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautotune.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html)\u003cbr/\u003eobject that describes the tuning job, including the search strategy, the\u003cbr/\u003eobjective metric used to evaluate training jobs, ranges of parameters to\u003cbr/\u003esearch, and resource limits for the tuning job. For more information, see\u003cbr/\u003eHow Hyperparameter Tuning Works (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-how-it-works.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.hyperParameterTuningJobObjective\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.hyperParameterTuningJobObjective.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**hyperParameterTuningJobConfig.hyperParameterTuningJobObjective.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eis eligible for Autotune, an optimal hyperparameter range is selected for\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.autoParameters.[].valueHint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of categorical hyperparameters to tune.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[].values\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.categoricalParameterRanges.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of continuous hyperparameters to tune.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.continuousParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etuning job searches.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.parameterRanges.integerParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the maximum number of training jobs and parallel training jobs\u003cbr/\u003ethat a hyperparameter tuning job can launch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits.maxNumberOfTrainingJobs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.resourceLimits.maxParallelTrainingJobs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.strategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe strategy hyperparameter tuning uses to find the best combination of hyperparameters\u003cbr/\u003efor your model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.trainingJobEarlyStoppingType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.tuningJobCompletionCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe job completion criteria.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobConfig.tuningJobCompletionCriteria.targetObjectiveMetricValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the tuning job. This name is the prefix for the names of all\u003cbr/\u003etraining jobs that this tuning job launches. The name must be unique within\u003cbr/\u003ethe same Amazon Web Services account and Amazon Web Services Region. The\u003cbr/\u003ename must have 1 to 32 characters. Valid characters are a-z, A-Z, 0-9, and\u003cbr/\u003e: + = @ _ % - (hyphen). The name is not case sensitive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags that you specify for the tuning job are also added to all training jobs\u003cbr/\u003ethat the tuning job launches.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)\u003cbr/\u003eobject that describes the training jobs that this tuning job launches, including\u003cbr/\u003estatic hyperparameters, input data configuration, output data configuration,\u003cbr/\u003eresource configuration, and stopping condition. |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies which training algorithm to use for training jobs that a hyperparameter\u003cbr/\u003etuning job launches and the metrics to monitor. |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.algorithmName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\nYou can view these logs to understand how your training job performs and\ncheck for any errors encountered during training. SageMaker hyperparameter\ntuning captures all defined metrics. Specify one of the defined metrics to\nuse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\nparameter in the HyperParameterTrainingJobDefinition API to evaluate job\nperformance during hyperparameter tuning. || \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.metricDefinitions.[].regex\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.trainingImage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.algorithmSpecification.trainingInputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data. |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.checkpointConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.definitionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableManagedSpotTraining\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified. |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\nin Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\nis eligible for Autotune, an optimal hyperparameter range is selected for\nyou. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.autoParameters.[].valueHint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of categorical hyperparameters to tune. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].values\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.categoricalParameterRanges.[].values.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of continuous hyperparameters to tune. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].maxValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.continuousParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\ntuning job searches. || \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].maxValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].minValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.hyperParameterRanges.integerParameterRanges.[].scalingType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA channel is a named input source that training algorithms can consume. || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].channelName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a file system data source for a channel. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.directoryPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.attributeNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.attributeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].inputMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].recordWrapperType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].shuffleConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch. |\n| \u003cstrong\u003etrainingJobDefinition.inputDataConfig.[].shuffleConfig.seed\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides information about how to store model training results (model artifacts). |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.outputDataConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including machine learning (ML) compute instances\u003cbr/\u003eand ML storage volumes, to use for model training. |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\na training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\nAPI, you can configure multiple instance groups . || \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceGroupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceGroups.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.keepAlivePeriodInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished. |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.resourceConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.retryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe retry strategy to use when a training job fails due to an InternalServerError.\u003cbr/\u003eRetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob\u003cbr/\u003erequests. You can add the StoppingCondition parameter to the request to limit\u003cbr/\u003ethe training time for the complete job. |\n| \u003cstrong\u003etrainingJobDefinition.retryStrategy.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.staticHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a limit to how long a model training job or model compilation job\u003cbr/\u003ecan run. It also specifies how long a managed spot training job has to complete.\u003cbr/\u003eWhen the job reaches the time limit, SageMaker ends the training or compilation\u003cbr/\u003ejob. Use this API to cap model training costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\u003cbr/\u003ewhich delays job termination for 120 seconds. Algorithms can use this 120-second\u003cbr/\u003ewindow to save the model artifacts, so the results of training are not lost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe training algorithms provided by SageMaker automatically save the intermediate\u003cbr/\u003eresults of a model training job when possible. This attempt to save artifacts\u003cbr/\u003eis only a best effort case as model might not be in a state from which it\u003cbr/\u003ecan be saved. For example, if training has just started, the model might\u003cbr/\u003enot be ready to save. When saved, this intermediate data is a valid model\u003cbr/\u003eartifact. You can use it to create a model with CreateModel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Neural Topic Model (NTM) currently does not support saving intermediate\u003cbr/\u003emodel artifacts. When training NTMs, make sure that the maximum runtime is\u003cbr/\u003esufficient for the training job to complete. |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxPendingTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eMaximum job scheduler pending time in seconds. |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.stoppingCondition.maxWaitTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobDefinition.tuningObjective\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). |\n| \u003cstrong\u003etrainingJobDefinition.tuningObjective.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **trainingJobDefinition.tuningObjective.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| **trainingJobDefinition.vpcConfig.securityGroupIDs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig.securityGroupIDs.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinition.vpcConfig.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinition.vpcConfig.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of the HyperParameterTrainingJobDefinition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html)\u003cbr/\u003eobjects launched for this tuning job. |\n| **trainingJobDefinitions.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDefines the training jobs launched by a hyperparameter tuning job. || **trainingJobDefinitions.[].algorithmSpecification**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies which training algorithm to use for training jobs that a hyperparameter\u003cbr/\u003etuning job launches and the metrics to monitor. |\n| **trainingJobDefinitions.[].algorithmSpecification.algorithmName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\nYou can view these logs to understand how your training job performs and\ncheck for any errors encountered during training. SageMaker hyperparameter\ntuning captures all defined metrics. Specify one of the defined metrics to\nuse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\nparameter in the HyperParameterTrainingJobDefinition API to evaluate job\nperformance during hyperparameter tuning. || **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.metricDefinitions.[].regex**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.trainingImage**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].algorithmSpecification.trainingInputMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| **trainingJobDefinitions.[].checkpointConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data. |\n| **trainingJobDefinitions.[].checkpointConfig.localPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].checkpointConfig.s3URI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].definitionName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableInterContainerTrafficEncryption**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableManagedSpotTraining**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].enableNetworkIsolation**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies ranges of integer, continuous, and categorical hyperparameters\u003cbr/\u003ethat a hyperparameter tuning job searches. The hyperparameter tuning job\u003cbr/\u003elaunches training jobs with hyperparameter values within these ranges to\u003cbr/\u003efind the combination of values that result in the training job with the best\u003cbr/\u003eperformance as measured by the objective metric of the hyperparameter tuning\u003cbr/\u003ejob.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum number of items specified for Array Members refers to the maximum\u003cbr/\u003enumber of hyperparameters for each range and also the maximum for the hyperparameter\u003cbr/\u003etuning job itself. That is, the sum of the number of hyperparameters for\u003cbr/\u003eall the ranges can\u0026rsquo;t exceed the maximum number specified. |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe name and an example value of the hyperparameter that you want to use\nin Autotune. If Automatic model tuning (AMT) determines that your hyperparameter\nis eligible for Autotune, an optimal hyperparameter range is selected for\nyou. || **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.autoParameters.[].valueHint**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of categorical hyperparameters to tune. || **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].values**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.categoricalParameterRanges.[].values.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of continuous hyperparameters to tune. || **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].maxValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].minValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.continuousParameterRanges.[].scalingType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eFor a hyperparameter of the integer type, specifies the range that a hyperparameter\ntuning job searches. || **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].maxValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].minValue**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].hyperParameterRanges.integerParameterRanges.[].scalingType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA channel is a named input source that training algorithms can consume. || **trainingJobDefinitions.[].inputDataConfig.[].channelName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].compressionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].contentType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the location of the channel data. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a file system data source for a channel. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.directoryPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job. |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.attributeNames**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.attributeNames.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3DataDistributionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3DataType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].dataSource.s3DataSource.s3URI**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].inputMode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided. |\n| **trainingJobDefinitions.[].inputDataConfig.[].recordWrapperType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].inputDataConfig.[].shuffleConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch. |\n| **trainingJobDefinitions.[].inputDataConfig.[].shuffleConfig.seed**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eProvides information about how to store model training results (model artifacts). |\n| **trainingJobDefinitions.[].outputDataConfig.compressionType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig.kmsKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].outputDataConfig.s3OutputPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDescribes the resources, including machine learning (ML) compute instances\u003cbr/\u003eand ML storage volumes, to use for model training. |\n| **trainingJobDefinitions.[].resourceConfig.instanceCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\na training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\nAPI, you can configure multiple instance groups . || **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceGroupName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceGroups.[].instanceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.instanceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.keepAlivePeriodInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished. |\n| **trainingJobDefinitions.[].resourceConfig.volumeKMSKeyID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].resourceConfig.volumeSizeInGB**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].retryStrategy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe retry strategy to use when a training job fails due to an InternalServerError.\u003cbr/\u003eRetryStrategy is specified as part of the CreateTrainingJob and CreateHyperParameterTuningJob\u003cbr/\u003erequests. You can add the StoppingCondition parameter to the request to limit\u003cbr/\u003ethe training time for the complete job. |\n| **trainingJobDefinitions.[].retryStrategy.maximumRetryAttempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].roleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].staticHyperParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].stoppingCondition**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies a limit to how long a model training job or model compilation job\u003cbr/\u003ecan run. It also specifies how long a managed spot training job has to complete.\u003cbr/\u003eWhen the job reaches the time limit, SageMaker ends the training or compilation\u003cbr/\u003ejob. Use this API to cap model training costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a training job, SageMaker sends the algorithm the SIGTERM signal,\u003cbr/\u003ewhich delays job termination for 120 seconds. Algorithms can use this 120-second\u003cbr/\u003ewindow to save the model artifacts, so the results of training are not lost.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe training algorithms provided by SageMaker automatically save the intermediate\u003cbr/\u003eresults of a model training job when possible. This attempt to save artifacts\u003cbr/\u003eis only a best effort case as model might not be in a state from which it\u003cbr/\u003ecan be saved. For example, if training has just started, the model might\u003cbr/\u003enot be ready to save. When saved, this intermediate data is a valid model\u003cbr/\u003eartifact. You can use it to create a model with CreateModel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Neural Topic Model (NTM) currently does not support saving intermediate\u003cbr/\u003emodel artifacts. When training NTMs, make sure that the maximum runtime is\u003cbr/\u003esufficient for the training job to complete. |\n| **trainingJobDefinitions.[].stoppingCondition.maxPendingTimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003eMaximum job scheduler pending time in seconds. |\n| **trainingJobDefinitions.[].stoppingCondition.maxRuntimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].stoppingCondition.maxWaitTimeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].tuningObjective**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eDefines the objective metric for a hyperparameter tuning job. Hyperparameter\u003cbr/\u003etuning uses the value of this metric to evaluate the training jobs it launches,\u003cbr/\u003eand returns the training job that results in either the highest or lowest\u003cbr/\u003evalue for this metric, depending on the value you specify for the Type parameter.\u003cbr/\u003eIf you want to define a custom objective metric, see Define metrics and environment\u003cbr/\u003evariables (https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics-variables.html). |\n| **trainingJobDefinitions.[].tuningObjective.metricName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].tuningObjective.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html). |\n| **trainingJobDefinitions.[].vpcConfig.securityGroupIDs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig.securityGroupIDs.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **trainingJobDefinitions.[].vpcConfig.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **trainingJobDefinitions.[].vpcConfig.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **warmStartConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eSpecifies the configuration for starting the hyperparameter tuning job using\u003cbr/\u003eone or more previous tuning jobs as a starting point. The results of previous\u003cbr/\u003etuning jobs are used to inform which combinations of hyperparameters to search\u003cbr/\u003eover in the new tuning job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll training jobs launched by the new hyperparameter tuning job are evaluated\u003cbr/\u003eby using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM\u003cbr/\u003eas the WarmStartType value for the warm start configuration, the training\u003cbr/\u003ejob that performs the best in the new tuning job is compared to the best\u003cbr/\u003etraining jobs from the parent tuning jobs. From these, the training job that\u003cbr/\u003eperforms the best as measured by the objective metric is returned as the\u003cbr/\u003eoverall best training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll training jobs launched by parent hyperparameter tuning jobs and the new\u003cbr/\u003ehyperparameter tuning jobs count against the limit of training jobs for the\u003cbr/\u003etuning job. |\n| **warmStartConfig.parentHyperParameterTuningJobs**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **warmStartConfig.parentHyperParameterTuningJobs.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA previously completed or stopped hyperparameter tuning job to be used as\na starting point for a new hyperparameter tuning job. || **warmStartConfig.parentHyperParameterTuningJobs.[].hyperParameterTuningJobName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **warmStartConfig.warmStartType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nbestTrainingJob: \n creationTime: string\n failureReason: string\n finalHyperParameterTuningJobObjectiveMetric: \n metricName: string\n type_: string\n value: number\n objectiveStatus: string\n trainingEndTime: string\n trainingJobARN: string\n trainingJobDefinitionName: string\n trainingJobName: string\n trainingJobStatus: string\n trainingStartTime: string\n tunedHyperParameters: {}\n tuningJobName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nhyperParameterTuningJobStatus: string\noverallBestTrainingJob: \n creationTime: string\n failureReason: string\n finalHyperParameterTuningJobObjectiveMetric: \n metricName: string\n type_: string\n value: number\n objectiveStatus: string\n trainingEndTime: string\n trainingJobARN: string\n trainingJobDefinitionName: string\n trainingJobName: string\n trainingJobStatus: string\n trainingStartTime: string\n tunedHyperParameters: {}\n tuningJobName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)\u003cbr/\u003eobject that describes the training job that completed with the best current\u003cbr/\u003eHyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eShows the latest objective metric emitted by a training job that was launched\u003cbr/\u003eby a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective\u003cbr/\u003eparameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.objectiveStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.trainingStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.tunedHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebestTrainingJob.tuningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the tuning job failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameterTuningJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the tuning job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIf the hyperparameter tuning job is an warm start tuning job with a WarmStartType\u003cbr/\u003eof IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)\u003cbr/\u003efor the training job with the best objective metric value of all training\u003cbr/\u003ejobs launched by this tuning job and all parent jobs specified for the warm\u003cbr/\u003estart tuning job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eShows the latest objective metric emitted by a training job that was launched\u003cbr/\u003eby a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective\u003cbr/\u003eparameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.objectiveStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.trainingStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.tunedHyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoverallBestTrainingJob.tuningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:113,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/instance/",title:"Instance",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#Instance"\u003eec2-controller/apis/v1alpha1#Instance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes an instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eblockDeviceMappings:\n- deviceName: string\n ebs: \n deleteOnTermination: boolean\n encrypted: boolean\n iops: integer\n kmsKeyID: string\n outpostARN: string\n snapshotID: string\n throughput: integer\n volumeSize: integer\n volumeType: string\n noDevice: string\n virtualName: string\ncapacityReservationSpecification: \n capacityReservationPreference: string\n capacityReservationTarget: \n capacityReservationID: string\n capacityReservationResourceGroupARN: string\ncpuOptions: \n coreCount: integer\n threadsPerCore: integer\ncreditSpecification: \n cpuCredits: string\ndisableAPIStop: boolean\ndisableAPITermination: boolean\nebsOptimized: boolean\nelasticGPUSpecification:\n- type_: string\nelasticInferenceAccelerators:\n- count: integer\n type_: string\nenclaveOptions: \n enabled: boolean\nhibernationOptions: \n configured: boolean\niamInstanceProfile: \n arn: string\n name: string\nimageID: string\ninstanceInitiatedShutdownBehavior: string\ninstanceMarketOptions: \n marketType: string\n spotOptions: \n blockDurationMinutes: integer\n instanceInterruptionBehavior: string\n maxPrice: string\n spotInstanceType: string\n validUntil: string\ninstanceType: string\nipv6AddressCount: integer\nipv6Addresses:\n- ipv6Address: string\nkernelID: string\nkeyName: string\nlaunchTemplate: \n launchTemplateID: string\n launchTemplateName: string\n version: string\nlicenseSpecifications:\n- licenseConfigurationARN: string\nmaintenanceOptions: \n autoRecovery: string\nmaxCount: integer\nmetadataOptions: \n httpEndpoint: string\n httpProtocolIPv6: string\n httpPutResponseHopLimit: integer\n httpTokens: string\n instanceMetadataTags: string\nminCount: integer\nmonitoring: \n enabled: boolean\nnetworkInterfaces:\n- associateCarrierIPAddress: boolean\n associatePublicIPAddress: boolean\n deleteOnTermination: boolean\n description: string\n deviceIndex: integer\n interfaceType: string\n ipv4PrefixCount: integer\n ipv4Prefixes:\n - ipv4Prefix: string\n ipv6AddressCount: integer\n ipv6Addresses:\n - ipv6Address: string\n ipv6PrefixCount: integer\n ipv6Prefixes:\n - ipv6Prefix: string\n networkCardIndex: integer\n networkInterfaceID: string\n privateIPAddress: string\n privateIPAddresses:\n - primary: boolean\n privateIPAddress: string\n secondaryPrivateIPAddressCount: integer\n subnetID: string\nplacement: \n affinity: string\n availabilityZone: string\n groupName: string\n hostID: string\n hostResourceGroupARN: string\n partitionNumber: integer\n spreadDomain: string\n tenancy: string\nprivateDNSNameOptions: \n enableResourceNameDNSAAAARecord: boolean\n enableResourceNameDNSARecord: boolean\n hostnameType: string\nprivateIPAddress: string\nramDiskID: string\nsecurityGroupIDs:\n- string\nsecurityGroups:\n- string\nsubnetID: string\ntags:\n- key: string\n value: string\nuserData: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe block device mapping, which defines the EBS volumes and instance store\u003cbr/\u003evolumes to attach to the instance at launch. For more information, see Block\u003cbr/\u003edevice mappings (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a block device mapping, which defines the EBS volumes and instance\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003estore volumes to attach to an instance at launch.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a block device for an EBS volume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.deleteOnTermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.iops\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.outpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.throughput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.volumeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].ebs.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].noDevice\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eblockDeviceMappings.[].virtualName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the Capacity Reservation targeting option. If you do not\u003cbr/\u003especify this parameter, the instance\u0026rsquo;s Capacity Reservation preference defaults\u003cbr/\u003eto open, which enables it to run in any open Capacity Reservation that has\u003cbr/\u003ematching attributes (instance type, platform, Availability Zone).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationPreference\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a target Capacity Reservation or Capacity Reservation group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget.capacityReservationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationSpecification.capacityReservationTarget.capacityReservationResourceGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe CPU options for the instance. For more information, see Optimize CPU\u003cbr/\u003eoptions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions.coreCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecpuOptions.threadsPerCore\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreditSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe credit option for CPU usage of the burstable performance instance. Valid\u003cbr/\u003evalues are standard and unlimited. To change this attribute after launch,\u003cbr/\u003euse ModifyInstanceCreditSpecification (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html).\u003cbr/\u003eFor more information, see Burstable performance instances (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: standard (T2 instances) or unlimited (T3/T3a/T4g instances)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor T3 instances with host tenancy, only standard is supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreditSpecification.cpuCredits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableAPIStop\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance is enabled for stop protection. For more information,\u003cbr/\u003esee Stop protection (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisableAPITermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you set this parameter to true, you can\u0026rsquo;t terminate the instance using\u003cbr/\u003ethe Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute\u003cbr/\u003eafter launch, use ModifyInstanceAttribute (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceAttribute.html).\u003cbr/\u003eAlternatively, if you set InstanceInitiatedShutdownBehavior to terminate,\u003cbr/\u003eyou can terminate the instance by running the shutdown command from the instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eebsOptimized\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the instance is optimized for Amazon EBS I/O. This optimization\u003cbr/\u003eprovides dedicated throughput to Amazon EBS and an optimized configuration\u003cbr/\u003estack to provide optimal Amazon EBS I/O performance. This optimization isn\u0026rsquo;t\u003cbr/\u003eavailable with all instance types. Additional usage charges apply when using\u003cbr/\u003ean EBS-optimized instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn elastic GPU to associate with the instance. An Elastic GPU is a GPU resource\u003cbr/\u003ethat you can attach to your Windows instance to accelerate the graphics performance\u003cbr/\u003eof your applications. For more information, see Amazon EC2 Elastic GPUs (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/elastic-graphics.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUSpecification.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA specification for an Elastic Graphics accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAccelerators\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn elastic inference accelerator to associate with the instance. Elastic\u003cbr/\u003einference accelerators are a resource you can attach to your Amazon EC2 instances\u003cbr/\u003eto accelerate your Deep Learning (DL) inference workloads.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify accelerators from different generations in the same request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAccelerators.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an elastic inference accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**elasticInferenceAccelerators.[].type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenclaveOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\u003cbr/\u003eFor more information, see What is Amazon Web Services Nitro Enclaves? (https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html)\u003cbr/\u003ein the Amazon Web Services Nitro Enclaves User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t enable Amazon Web Services Nitro Enclaves and hibernation on the\u003cbr/\u003esame instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenclaveOptions.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehibernationOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance is enabled for hibernation. For more information,\u003cbr/\u003esee Hibernate your instance (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t enable hibernation and Amazon Web Services Nitro Enclaves on the\u003cbr/\u003esame instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehibernationOptions.configured\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of an IAM instance profile.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eiamInstanceProfile.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the AMI. An AMI ID is required to launch an instance and must be\u003cbr/\u003especified here or in a launch template.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceInitiatedShutdownBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether an instance stops or terminates when you initiate shutdown\u003cbr/\u003efrom the instance (using the operating system command for system shutdown).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: stop\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe market (purchasing) option for the instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor RunInstances, persistent Spot Instance requests are only supported when\u003cbr/\u003eInstanceInterruptionBehavior is set to either hibernate or stop.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.marketType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe options for Spot Instances.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.blockDurationMinutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.instanceInterruptionBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.maxPrice\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.spotInstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceMarketOptions.spotOptions.validUntil\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe instance type. For more information, see Instance types (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: m1.small\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6AddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The number of IPv6 addresses to associate with the primary network\u003cbr/\u003einterface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet.\u003cbr/\u003eYou cannot specify this option and the option to assign specific IPv6 addresses\u003cbr/\u003ein the same request. You can specify this option if you\u0026rsquo;ve specified a minimum\u003cbr/\u003enumber of instances to launch.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Addresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with\u003cbr/\u003ethe primary network interface. You cannot specify this option and the option\u003cbr/\u003eto assign a number of IPv6 addresses in the same request. You cannot specify\u003cbr/\u003ethis option if you\u0026rsquo;ve specified a minimum number of instances to launch.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Addresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekernelID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the kernel.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\u003cbr/\u003einformation, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the key pair. You can create a key pair using CreateKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html)\u003cbr/\u003eor ImportKeyPair (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not specify a key pair, you can\u0026rsquo;t connect to the instance unless\u003cbr/\u003eyou choose an AMI that is configured to allow users another way to log in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe launch template to use to launch the instances. Any parameters that you\u003cbr/\u003especify in RunInstances override the same parameters in the launch template.\u003cbr/\u003eYou can specify either the name or ID of a launch template, but not both.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.launchTemplateID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.launchTemplateName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.version\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe license configurations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a license configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe maintenance and recovery options for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaintenanceOptions.autoRecovery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of instances to launch. If you specify more instances\u003cbr/\u003ethan Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches\u003cbr/\u003ethe largest possible number of instances above MinCount.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Between 1 and the maximum number you\u0026rsquo;re allowed for the specified\u003cbr/\u003einstance type. For more information about the default limits, and how to\u003cbr/\u003erequest an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2)\u003cbr/\u003ein the Amazon EC2 FAQ.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata options for the instance. For more information, see Instance\u003cbr/\u003emetadata and user data (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpProtocolIPv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpPutResponseHopLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.httpTokens\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataOptions.instanceMetadataTags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe minimum number of instances to launch. If you specify a minimum that\u003cbr/\u003eis more instances than Amazon EC2 can launch in the target Availability Zone,\u003cbr/\u003eAmazon EC2 launches no instances.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Between 1 and the maximum number you\u0026rsquo;re allowed for the specified\u003cbr/\u003einstance type. For more information about the default limits, and how to\u003cbr/\u003erequest an increase, see How many instances can I run in Amazon EC2 (http://aws.amazon.com/ec2/faqs/#How_many_instances_can_I_run_in_Amazon_EC2)\u003cbr/\u003ein the Amazon EC2 General FAQ.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether detailed monitoring is enabled for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoring.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe network interfaces to associate with the instance. If you specify a network\u003cbr/\u003einterface, you must specify any security groups and subnets as part of the\u003cbr/\u003enetwork interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].associatePublicIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].deleteOnTermination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].deviceIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].interfaceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4PrefixCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4Prefixes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv4Prefixes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IPv4 prefix option for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6AddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Addresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Addresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 address.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6PrefixCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Prefixes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].ipv6Prefixes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IPv4 prefix option for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].networkCardIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a secondary private IPv4 address for a network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].privateIPAddresses.[].privateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].secondaryPrivateIPAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaces.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe placement for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.affinity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.availabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.hostID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.hostResourceGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.partitionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.spreadDomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplacement.tenancy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe options for the instance hostname. The default values are inherited from\u003cbr/\u003ethe subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.enableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.enableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptions.hostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4\u003cbr/\u003eaddress range of the subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnly one private IP address can be designated as primary. You can\u0026rsquo;t specify\u003cbr/\u003ethis option if you\u0026rsquo;ve specified the option to designate a private IP address\u003cbr/\u003eas the primary IP address in a network interface specification. You cannot\u003cbr/\u003especify this option if you\u0026rsquo;re launching more than one instance in the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot specify this option and the network interfaces option in the same\u003cbr/\u003erequest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eramDiskID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the RAM disk to select. Some kernels require additional drivers\u003cbr/\u003eat launch. Check the kernel requirements for information about whether you\u003cbr/\u003eneed to specify a RAM disk. To find kernel requirements, go to the Amazon\u003cbr/\u003eWeb Services Resource Center and search for the kernel ID.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\u003cbr/\u003einformation, see PV-GRUB (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IDs of the security groups. You can create a security group using CreateSecurityGroup\u003cbr/\u003e(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSecurityGroup.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify a network interface, you must specify any security groups\u003cbr/\u003eas part of the network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe user data script to make available to the instance. For more information,\u003cbr/\u003esee Run commands on your Linux instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html)\u003cbr/\u003eand Run commands on your Windows instance at launch (https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-windows-user-data.html).\u003cbr/\u003eIf you are using a command line tool, base64-encoding is performed for you,\u003cbr/\u003eand you can load the text from a file. Otherwise, you must provide base64-encoded\u003cbr/\u003etext. User data is limited to 16 KB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\namiLaunchIndex: integer\narchitecture: string\nbootMode: string\ncapacityReservationID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nelasticGPUAssociations:\n- elasticGPUAssociationID: string\n elasticGPUAssociationState: string\n elasticGPUAssociationTime: string\n elasticGPUID: string\nelasticInferenceAcceleratorAssociations:\n- elasticInferenceAcceleratorARN: string\n elasticInferenceAcceleratorAssociationID: string\n elasticInferenceAcceleratorAssociationState: string\n elasticInferenceAcceleratorAssociationTime: string\nenaSupport: boolean\nhypervisor: string\ninstanceID: string\ninstanceLifecycle: string\nipv6Address: string\nlaunchTime: string\nlicenses:\n- licenseConfigurationARN: string\noutpostARN: string\nplatform: string\nplatformDetails: string\nprivateDNSName: string\nproductCodes:\n- productCodeID: string\n productCodeType: string\npublicDNSName: string\npublicIPAddress: string\nrootDeviceName: string\nrootDeviceType: string\nsourceDestCheck: boolean\nspotInstanceRequestID: string\nsriovNetSupport: string\nstate: \n code: integer\n name: string\nstateReason: \n code: string\n message: string\nstateTransitionReason: string\ntpmSupport: string\nusageOperation: string\nusageOperationUpdateTime: string\nvirtualizationType: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamiLaunchIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe AMI launch index, which can be used to find this instance in the launch\u003cbr/\u003egroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitecture\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe architecture of the image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebootMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe boot mode of the instance. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityReservationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Capacity Reservation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Elastic GPU associated with the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the association between an instance and an Elastic Graphics accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUAssociationState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUAssociationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticGPUAssociations.[].elasticGPUID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe elastic inference accelerator associated with the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the association between an instance and an elastic inference accelerator.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eelasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenaSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehypervisor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe hypervisor type of the instance. The value xen is used for both Xen and\u003cbr/\u003eNitro hypervisors.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceLifecycle\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is a Spot Instance or a Scheduled Instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 address assigned to the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time the instance was launched.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe license configurations for the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a license configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatform\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe value is Windows for Windows instances; otherwise blank.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform details value for the instance. For more information, see AMI\u003cbr/\u003ebilling information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(IPv4 only) The private DNS hostname name assigned to the instance. This\u003cbr/\u003eDNS hostname can only be used inside the Amazon EC2 network. This name is\u003cbr/\u003enot available until the instance enters the running state.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private\u003cbr/\u003eDNS hostnames if you\u0026rsquo;ve enabled DNS resolution and DNS hostnames in your\u003cbr/\u003eVPC. If you are not using the Amazon-provided DNS server in your VPC, your\u003cbr/\u003ecustom domain name servers must resolve the hostname as appropriate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe product codes attached to this instance, if applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a product code.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eproductCodes.[].productCodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicDNSName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(IPv4 only) The public DNS name assigned to the instance. This name is not\u003cbr/\u003eavailable until the instance enters the running state. For EC2-VPC, this\u003cbr/\u003ename is only available if you\u0026rsquo;ve enabled DNS hostnames for your VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epublicIPAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe public IPv4 address, or the Carrier IP address assigned to the instance,\u003cbr/\u003eif applicable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA Carrier IP address only applies to an instance launched in a subnet associated\u003cbr/\u003ewith a Wavelength Zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDeviceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe device name of the root device volume (for example, /dev/sda1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootDeviceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe root device type used by the AMI. The AMI can use an EBS volume or an\u003cbr/\u003einstance store volume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceDestCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether source/destination checking is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003espotInstanceRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the request is a Spot Instance request, the ID of the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esriovNetSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function\u003cbr/\u003einterface is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe current state of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe reason for the most recent state transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateTransitionReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the most recent state transition. This might be an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etpmSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the instance is configured for NitroTPM support, the value is v2.0. For\u003cbr/\u003emore information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageOperation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe usage operation value for the instance. For more information, see AMI\u003cbr/\u003ebilling information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)\u003cbr/\u003ein the Amazon EC2 User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eusageOperationUpdateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that the usage operation was last updated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualizationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtualization type of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC] The ID of the VPC in which the instance is running.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:114,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/instanceprofile/",title:"InstanceProfile",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#InstanceProfile"\u003eiam-controller/apis/v1alpha1#InstanceProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInstanceProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstanceprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einstanceprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an instance profile.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateInstanceProfile\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetInstanceProfile\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListInstanceProfiles\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListInstanceProfilesForRole\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\npath: string\nrole: string\nroleRef: \n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the instance profile to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of upper and lowercase alphanumeric characters\u003cbr/\u003ewith no spaces. You can also include any of the following characters: _+=,.@-\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the instance profile. For more information about paths, see IAM\u003cbr/\u003eIdentifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the newly created IAM instance\u003cbr/\u003eprofile. Each tag consists of a key name and an associated value. For more\u003cbr/\u003einformation about tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ninstanceProfileID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date when the instance profile was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceProfileID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the instance profile. For more information\u003cbr/\u003eabout IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:115,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/integration/",title:"Integration",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Integration"\u003eapigatewayv2-controller/apis/v1alpha1#Integration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eIntegration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eIntegrationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eintegrations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eintegration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an integration.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiRef: \n from: \n name: string\nconnectionID: string\nconnectionRef: \n from: \n name: string\nconnectionType: string\ncontentHandlingStrategy: string\ncredentialsARN: string\ndescription: string\nintegrationMethod: string\nintegrationSubtype: string\nintegrationType: string\nintegrationURI: string\npassthroughBehavior: string\npayloadFormatVersion: string\nrequestParameters: {}\nrequestTemplates: {}\nresponseParameters: {}\ntemplateSelectionExpression: string\ntimeoutInMillis: integer\ntlsConfig: \n serverNameToVerify: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentHandlingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecredentialsARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationMethod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationSubtype\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epassthroughBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epayloadFormatVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestTemplates\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etemplateSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeoutInMillis\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TLS configuration for a private integration. If you specify a TLS configuration,\u003cbr/\u003eprivate integration traffic uses the HTTPS protocol. Supported only for HTTP\u003cbr/\u003eAPIs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etlsConfig.serverNameToVerify\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string with a length between [1-512].\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nintegrationID: string\nintegrationResponseSelectionExpression: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eintegrationResponseSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:116,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/internetgateway/",title:"InternetGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#InternetGateway"\u003eec2-controller/apis/v1alpha1#InternetGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInternetGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eInternetGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einternetgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003einternetgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes an internet gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003erouteTableRefs:\n from: \n name: string\nrouteTables:\n- string\ntags:\n- key: string\n value: string\nvpc: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpc\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nattachments:\n- state: string\n vpcID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ninternetGatewayID: string\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAny VPCs attached to the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the attachment of a VPC to an internet gateway or an egress-only\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003einternet gateway.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachments.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the internet gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:117,href:"https://aws-controllers-k8s.github.io/community/reference/emrcontainers/v1alpha1/jobrun/",title:"JobRun",description:null,content:'\u003cp\u003e\u003ccode\u003eemrcontainers.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/emrcontainers-controller/apis/v1alpha1#JobRun"\u003eemrcontainers-controller/apis/v1alpha1#JobRun\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eJobRun\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eJobRunList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ejobruns\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ejobrun\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis entity describes a job run. A job run is a unit of work, such as a Spark\njar, PySpark script, or SparkSQL query, that you submit to Amazon EMR on\nEKS.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfigurationOverrides: string\nexecutionRoleARN: string\njobDriver: \n sparkSubmitJobDriver: \n entryPoint: string\n entryPointArguments:\n - string\n sparkSubmitParameters: string\nname: string\nreleaseLabel: string\ntags: {}\nvirtualClusterID: string\nvirtualClusterRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe execution role ARN for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe job driver for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about job driver for Spark submit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPointArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDriver.sparkSubmitJobDriver.entryPointArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereleaseLabel\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon EMR release version to use for the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tags assigned to job runs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtual cluster ID for which the job run request is submitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evirtualClusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nstate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis output displays the started job run ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the job run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:118,href:"https://aws-controllers-k8s.github.io/community/reference/kms/v1alpha1/key/",title:"Key",description:null,content:'\u003cp\u003e\u003ccode\u003ekms.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kms-controller/apis/v1alpha1#Key"\u003ekms-controller/apis/v1alpha1#Key\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKey\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeys\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekey\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebypassPolicyLockoutSafetyCheck: boolean\ncustomKeyStoreID: string\ndescription: string\nenableKeyRotation: boolean\nkeySpec: string\nkeyUsage: string\nmultiRegion: boolean\norigin: string\npolicy: string\ntags:\n- tagKey: string\n tagValue: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebypassPolicyLockoutSafetyCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag to indicate whether to bypass the key policy lockout safety check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSetting this value to true increases the risk that the KMS key becomes unmanageable.\u003cbr/\u003eDo not set this value to true indiscriminately.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, refer to the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)\u003cbr/\u003esection in the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse this parameter only when you include a policy in the request and you\u003cbr/\u003eintend to prevent the principal that is making the request from making a\u003cbr/\u003esubsequent PutKeyPolicy request on the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default value is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomKeyStoreID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eCreates the KMS key in the specified custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003eand the key material in its associated CloudHSM cluster. To create a KMS\u003cbr/\u003ekey in a custom key store, you must also specify the Origin parameter with\u003cbr/\u003ea value of AWS_CLOUDHSM. The CloudHSM cluster that is associated with the\u003cbr/\u003ecustom key store must have at least two active HSMs, each in a different\u003cbr/\u003eAvailability Zone in the Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is valid only for symmetric encryption KMS keys in a single\u003cbr/\u003eRegion. You cannot create any other type of KMS key in a custom key store.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo find the ID of a custom key store, use the DescribeCustomKeyStores operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe response includes the custom key store ID and the ID of the CloudHSM\u003cbr/\u003ecluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis operation is part of the custom key store feature (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003efeature in KMS, which combines the convenience and extensive integration\u003cbr/\u003eof KMS with the isolation and control of a single-tenant key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUse a description that helps you decide whether the KMS key is appropriate\u003cbr/\u003efor a task. The default value is an empty string (no description).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo set or change the description after the key is created, use UpdateKeyDescription.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableKeyRotation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeySpec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the type of KMS key to create. The default value, SYMMETRIC_DEFAULT,\u003cbr/\u003ecreates a KMS key with a 256-bit AES-GCM key that is used for encryption\u003cbr/\u003eand decryption, except in China Regions, where it creates a 128-bit symmetric\u003cbr/\u003ekey that uses SM4 encryption. For help choosing a key spec for your KMS key,\u003cbr/\u003esee Choosing a KMS key type (https://docs.aws.amazon.com/kms/latest/developerguide/key-types.html#symm-asymm-choose)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe KeySpec determines whether the KMS key contains a symmetric key or an\u003cbr/\u003easymmetric key pair. It also determines the cryptographic algorithms that\u003cbr/\u003ethe KMS key supports. You can\u0026rsquo;t change the KeySpec after the KMS key is created.\u003cbr/\u003eTo further restrict the algorithms that can be used with the KMS key, use\u003cbr/\u003ea condition key in its key policy or IAM policy. For more information, see\u003cbr/\u003ekms:EncryptionAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-encryption-algorithm),\u003cbr/\u003ekms:MacAlgorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-mac-algorithm)\u003cbr/\u003eor kms:Signing Algorithm (https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms-signing-algorithm)\u003cbr/\u003ein the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAmazon Web Services services that are integrated with KMS (http://aws.amazon.com/kms/features/#AWS_Service_Integration)\u003cbr/\u003euse symmetric encryption KMS keys to protect your data. These services do\u003cbr/\u003enot support asymmetric KMS keys or HMAC KMS keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eKMS supports the following key specs for KMS keys:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Symmetric encryption key (default) SYMMETRIC_DEFAULT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HMAC keys (symmetric) HMAC_224 HMAC_256 HMAC_384 HMAC_512\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Asymmetric RSA key pairs RSA_2048 RSA_3072 RSA_4096\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Asymmetric NIST-recommended elliptic curve key pairs ECC_NIST_P256 (secp256r1)\u003cbr/\u003e ECC_NIST_P384 (secp384r1) ECC_NIST_P521 (secp521r1)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Other asymmetric elliptic curve key pairs ECC_SECG_P256K1 (secp256k1),\u003cbr/\u003e commonly used for cryptocurrencies.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SM2 key pairs (China Regions only) SM2\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyUsage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDetermines the cryptographic operations (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations)\u003cbr/\u003efor which you can use the KMS key. The default value is ENCRYPT_DECRYPT.\u003cbr/\u003eThis parameter is optional when you are creating a symmetric encryption KMS\u003cbr/\u003ekey; otherwise, it is required. You can\u0026rsquo;t change the KeyUsage value after\u003cbr/\u003ethe KMS key is created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSelect only one valid value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For symmetric encryption KMS keys, omit the parameter or specify ENCRYPT_DECRYPT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For HMAC KMS keys (symmetric), specify GENERATE_VERIFY_MAC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with RSA key material, specify ENCRYPT_DECRYPT\u003cbr/\u003e or SIGN_VERIFY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with ECC key material, specify SIGN_VERIFY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For asymmetric KMS keys with SM2 key material (China Regions only),\u003cbr/\u003e specify ENCRYPT_DECRYPT or SIGN_VERIFY.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eCreates a multi-Region primary key that you can replicate into other Amazon\u003cbr/\u003eWeb Services Regions. You cannot change this value after you create the KMS\u003cbr/\u003ekey.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a multi-Region key, set this parameter to True. For a single-Region KMS\u003cbr/\u003ekey, omit this parameter or set it to False. The default value is False.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis operation supports multi-Region keys, an KMS feature that lets you create\u003cbr/\u003emultiple interoperable KMS keys in different Amazon Web Services Regions.\u003cbr/\u003eBecause these KMS keys have the same key ID, key material, and other metadata,\u003cbr/\u003eyou can use them interchangeably to encrypt data in one Amazon Web Services\u003cbr/\u003eRegion and decrypt it in a different Amazon Web Services Region without re-encrypting\u003cbr/\u003ethe data or making a cross-Region call. For more information about multi-Region\u003cbr/\u003ekeys, see Multi-Region keys in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value creates a primary key, not a replica. To create a replica key,\u003cbr/\u003euse the ReplicateKey operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can create a multi-Region version of a symmetric encryption KMS key,\u003cbr/\u003ean HMAC KMS key, an asymmetric KMS key, or a KMS key with imported key material.\u003cbr/\u003eHowever, you cannot create a multi-Region key in a custom key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eorigin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe source of the key material for the KMS key. You cannot change the origin\u003cbr/\u003eafter you create the KMS key. The default is AWS_KMS, which means that KMS\u003cbr/\u003ecreates the key material.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a KMS key with no key material (for imported key material), set\u003cbr/\u003ethe value to EXTERNAL. For more information about importing key material\u003cbr/\u003einto KMS, see Importing Key Material (https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html)\u003cbr/\u003ein the Key Management Service Developer Guide. This value is valid only for\u003cbr/\u003esymmetric encryption KMS keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a KMS key in an KMS custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html)\u003cbr/\u003eand create its key material in the associated CloudHSM cluster, set this\u003cbr/\u003evalue to AWS_CLOUDHSM. You must also use the CustomKeyStoreId parameter to\u003cbr/\u003eidentify the custom key store. This value is valid only for symmetric encryption\u003cbr/\u003eKMS keys.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe key policy to attach to the KMS key. If you do not specify a key policy,\u003cbr/\u003eKMS attaches a default key policy to the KMS key. For more information, see\u003cbr/\u003eDefault key policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you provide a key policy, it must meet the following criteria:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you don\u0026rsquo;t set BypassPolicyLockoutSafetyCheck to True, the key policy\u003cbr/\u003e must allow the principal that is making the CreateKey request to make\u003cbr/\u003e a subsequent PutKeyPolicy request on the KMS key. This reduces the risk\u003cbr/\u003e that the KMS key becomes unmanageable. For more information, refer to\u003cbr/\u003e the scenario in the Default Key Policy (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam)\u003cbr/\u003e section of the Key Management Service Developer Guide .\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Each statement in the key policy must contain one or more principals.\u003cbr/\u003e The principals in the key policy must exist and be visible to KMS. When\u003cbr/\u003e you create a new Amazon Web Services principal (for example, an IAM user\u003cbr/\u003e or role), you might need to enforce a delay before including the new principal\u003cbr/\u003e in a key policy because the new principal might not be immediately visible\u003cbr/\u003e to KMS. For more information, see Changes that I make are not always immediately\u003cbr/\u003e visible (https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency)\u003cbr/\u003e in the Amazon Web Services Identity and Access Management User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA key policy document can include only the following characters:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Printable ASCII characters from the space character (\\u0020) through\u003cbr/\u003e the end of the ASCII character range.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) special\u003cbr/\u003e characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about key policies, see Key policies in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html)\u003cbr/\u003ein the Key Management Service Developer Guide. For help writing and formatting\u003cbr/\u003ea JSON policy document, see the IAM JSON Policy Reference (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html)\u003cbr/\u003ein the Identity and Access Management User Guide .\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAssigns one or more tags to the KMS key. Use this parameter to tag the KMS\u003cbr/\u003ekey when it is created. To tag an existing KMS key, use the TagResource operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTagging or untagging a KMS key can allow or deny permission to the KMS key.\u003cbr/\u003eFor details, see ABAC in KMS (https://docs.aws.amazon.com/kms/latest/developerguide/abac.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use this parameter, you must have kms:TagResource (https://docs.aws.amazon.com/kms/latest/developerguide/kms-api-permissions-reference.html)\u003cbr/\u003epermission in an IAM policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach tag consists of a tag key and a tag value. Both the tag key and the\u003cbr/\u003etag value are required, but the tag value can be an empty (null) string.\u003cbr/\u003eYou cannot have more than one tag on a KMS key with the same tag key. If\u003cbr/\u003eyou specify an existing tag key with a different tag value, KMS replaces\u003cbr/\u003ethe current tag value with the specified one.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you add tags to an Amazon Web Services resource, Amazon Web Services\u003cbr/\u003egenerates a cost allocation report with usage and costs aggregated by tags.\u003cbr/\u003eTags can also be used to control access to a KMS key. For details, see Tagging\u003cbr/\u003eKeys (https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair. A tag consists of a tag key and a tag value. Tag keys and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etag values are both required, but tag values can be empty (null) strings.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor information about the rules that apply to tag keys and tag values, see\nUser-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)\nin the Amazon Web Services Billing and Cost Management User Guide. || \u003cstrong\u003etags.[].tagKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].tagValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nawsAccountID: string\ncloudHsmClusterID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\ndeletionDate: string\nenabled: boolean\nencryptionAlgorithms:\n- string\nexpirationModel: string\nkeyID: string\nkeyManager: string\nkeyState: string\nmacAlgorithms:\n- string\nmultiRegionConfiguration: \n multiRegionKeyType: string\n primaryKey: \n arn: string\n region: string\n replicaKeys:\n - arn: string\n region: string\npendingDeletionWindowInDays: integer\nsigningAlgorithms:\n- string\nvalidTo: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eawsAccountID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe twelve-digit account ID of the Amazon Web Services account that owns\u003cbr/\u003ethe KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudHsmClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster ID of the CloudHSM cluster that contains the key material for\u003cbr/\u003ethe KMS key. When you create a KMS key in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),\u003cbr/\u003eKMS creates the key material for the KMS key in the associated CloudHSM cluster.\u003cbr/\u003eThis value is present only when the KMS key is created in a custom key store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the KMS key was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time after which KMS deletes this KMS key. This value is present\u003cbr/\u003eonly when the KMS key is scheduled for deletion, that is, when its KeyState\u003cbr/\u003eis PendingDeletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the primary key in a multi-Region key is scheduled for deletion but\u003cbr/\u003estill has replica keys, its key state is PendingReplicaDeletion and the length\u003cbr/\u003eof its waiting period is displayed in the PendingDeletionWindowInDays field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the KMS key is enabled. When KeyState is Enabled this value\u003cbr/\u003eis true, otherwise it is false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe encryption algorithms that the KMS key supports. You cannot use the KMS\u003cbr/\u003ekey with other encryption algorithms within KMS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe globally unique identifier for the KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyManager\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe manager of the KMS key. KMS keys in your Amazon Web Services account\u003cbr/\u003eare either customer managed or Amazon Web Services managed. For more information\u003cbr/\u003eabout the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the KMS key.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about how key state affects the use of a KMS key, see\u003cbr/\u003eKey states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emacAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe message authentication code (MAC) algorithm that the HMAC KMS key supports.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emacAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.multiRegionKeyType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the primary or replica key in a multi-Region key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.primaryKey.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the primary or replica key in a multi-Region key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiRegionConfiguration.replicaKeys.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingDeletionWindowInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe waiting period before the primary key in a multi-Region key is deleted.\u003cbr/\u003eThis waiting period begins when the last of its replica keys is deleted.\u003cbr/\u003eThis value is present only when the KeyState of the KMS key is PendingReplicaDeletion.\u003cbr/\u003eThat indicates that the KMS key is the primary key in a multi-Region key,\u003cbr/\u003eit is scheduled for deletion, and it still has existing replica keys.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a single-Region KMS key or a multi-Region replica key is scheduled for\u003cbr/\u003edeletion, its deletion date is displayed in the DeletionDate field. However,\u003cbr/\u003ewhen the primary key in a multi-Region key is scheduled for deletion, its\u003cbr/\u003ewaiting period doesn\u0026rsquo;t begin until all of its replica keys are deleted. This\u003cbr/\u003evalue displays that waiting period. When the last replica key in the multi-Region\u003cbr/\u003ekey is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion\u003cbr/\u003eto PendingDeletion and the deletion date appears in the DeletionDate field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe signing algorithms that the KMS key supports. You cannot use the KMS\u003cbr/\u003ekey with other signing algorithms within KMS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:119,href:"https://aws-controllers-k8s.github.io/community/reference/keyspaces/v1alpha1/keyspace/",title:"Keyspace",description:null,content:'\u003cp\u003e\u003ccode\u003ekeyspaces.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/keyspaces-controller/apis/v1alpha1#Keyspace"\u003ekeyspaces-controller/apis/v1alpha1#Keyspace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eKeyspaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeyspaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ekeyspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ekeyspaceName: string\nreplicationSpecification: \n regionList:\n - string\n replicationStrategy: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyspaceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the keyspace to be created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe replication specification of the keyspace includes:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * replicationStrategy - the required value is SINGLE_REGION or MULTI_REGION.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * regionList - if the replicationStrategy is MULTI_REGION, the regionList\u003cbr/\u003e requires the current Region and at least one additional Amazon Web Services\u003cbr/\u003e Region where the keyspace is going to be replicated in. The maximum number\u003cbr/\u003e of supported replication Regions including the current Region is six.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification.regionList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationSpecification.regionList.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pair tags to be attached to the keyspace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\u003cbr/\u003e(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea single Amazon Keyspaces resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\n(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\nin the Amazon Keyspaces Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nresourceARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier of the keyspace in the format of an Amazon Resource\u003cbr/\u003eName (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:120,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/layerversion/",title:"LayerVersion",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#LayerVersion"\u003elambda-controller/apis/v1alpha1#LayerVersion\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLayerVersion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLayerVersionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003elayerversions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003elayerversion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecompatibleArchitectures:\n- string\ncompatibleRuntimes:\n- string\ncontent: \n s3Bucket: string\n s3Key: string\n s3ObjectVersion: string\n zipFile: string\ndescription: string\nlayerName: string\nlicenseInfo: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleArchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of compatible instruction set architectures (https://docs.aws.amazon.com/lambda/latest/dg/foundation-arch.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleArchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibleRuntimes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3Bucket\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3Key\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.s3ObjectVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtent.zipFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the layer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elicenseInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe layer\u0026rsquo;s software license. It can be any of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * An SPDX license identifier (https://spdx.org/licenses/). For example,\u003cbr/\u003e MIT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The full text of the license.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nlayerARN: string\nversionNumber: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayerARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the layer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversionNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe version number.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:121,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/loggingconfiguration/",title:"LoggingConfiguration",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#LoggingConfiguration"\u003eprometheusservice-controller/apis/v1alpha1#LoggingConfiguration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLoggingConfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLoggingConfigurationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggingconfigurations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggingconfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003elogGroupARN: string\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogGroupARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the CW log group to which the vended log data will be published.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace to vend logs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatusCode: string\nstatusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus code of the logging configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for failure if any.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:122,href:"https://aws-controllers-k8s.github.io/community/reference/cloudwatchlogs/v1alpha1/loggroup/",title:"LogGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudwatchlogs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudwatchlogs-controller/apis/v1alpha1#LogGroup"\u003ecloudwatchlogs-controller/apis/v1alpha1#LogGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLogGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eLogGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eloggroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a log group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ekmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nname: string\nretentionDays: integer\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the KMS key to use when encrypting log\u003cbr/\u003edata. For more information, see Amazon Resource Names (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe key-value pairs to use for the tags.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can grant users access to certain log groups while preventing them from\u003cbr/\u003eaccessing other log groups. To do so, tag your groups and use IAM policies\u003cbr/\u003ethat refer to those tags. To assign tags when you create a log group, you\u003cbr/\u003emust have either the logs:TagResource or logs:TagLogGroup permission. For\u003cbr/\u003emore information about tagging, see Tagging Amazon Web Services resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). For more\u003cbr/\u003einformation about using tags to control access, see Controlling access to\u003cbr/\u003eAmazon Web Services resources using tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: integer\ndataProtectionStatus: string\nmetricFilterCount: integer\nretentionInDays: integer\nstoredBytes: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe creation time of the log group, expressed as the number of milliseconds\u003cbr/\u003eafter Jan 1, 1970 00:00:00 UTC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProtectionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDisplays whether this log group has a protection policy, or whether it had\u003cbr/\u003eone in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetricFilterCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of metric filters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionInDays\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoredBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of bytes stored.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:123,href:"https://aws-controllers-k8s.github.io/community/reference/cloudwatch/v1alpha1/metricalarm/",title:"MetricAlarm",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudwatch.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudwatch-controller/apis/v1alpha1#MetricAlarm"\u003ecloudwatch-controller/apis/v1alpha1#MetricAlarm\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMetricAlarm\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMetricAlarmList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emetricalarms\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emetricalarm\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details about a metric alarm.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eactionsEnabled: boolean\nalarmActions:\n- string\nalarmDescription: string\ncomparisonOperator: string\ndatapointsToAlarm: integer\ndimensions:\n- name: string\n value: string\nevaluateLowSampleCountPercentile: string\nevaluationPeriods: integer\nextendedStatistic: string\ninsufficientDataActions:\n- string\nmetricName: string\nmetrics:\n- accountID: string\n expression: string\n id: string\n label: string\n metricStat: \n metric: \n dimensions:\n - name: string\n value: string\n metricName: string\n namespace: string\n period: integer\n stat: string\n unit: string\n period: integer\n returnData: boolean\nname: string\nnamespace: string\noKActions:\n- string\nperiod: integer\nstatistic: string\ntags:\n- key: string\n value: string\nthreshold: number\nthresholdMetricID: string\ntreatMissingData: string\nunit: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eactionsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether actions should be executed during any changes to the alarm\u003cbr/\u003estate. The default is TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarmActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to the ALARM state from\u003cbr/\u003eany other state. Each action is specified as an Amazon Resource Name (ARN).\u003cbr/\u003eValid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarmActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomparisonOperator\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe arithmetic operation to use when comparing the specified statistic and\u003cbr/\u003ethreshold. The specified statistic value is used as the first operand.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold,\u003cbr/\u003eand GreaterThanUpperThreshold are used only for alarms based on anomaly detection\u003cbr/\u003emodels.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edatapointsToAlarm\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of data points that must be breaching to trigger the alarm. This\u003cbr/\u003eis used only if you are setting an \u0026ldquo;M out of N\u0026rdquo; alarm. In that case, this\u003cbr/\u003evalue is the M. For more information, see Evaluating an Alarm (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation)\u003cbr/\u003ein the Amazon CloudWatch User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edimensions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe dimensions for the metric specified in MetricName.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dimension is a name/value pair that is part of the identity of a metric.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eBecause dimensions are part of the unique identifier for a metric, whenever\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eyou add a unique name/value pair to one of your metrics, you are creating\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea new variation of that metric. For example, many Amazon EC2 metrics publish\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eInstanceId as a dimension name, and the actual instance ID as the value for\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat dimension.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can assign up to 30 dimensions to a metric. || \u003cstrong\u003edimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevaluateLowSampleCountPercentile\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUsed only for alarms based on percentiles. If you specify ignore, the alarm\u003cbr/\u003estate does not change during periods with too few data points to be statistically\u003cbr/\u003esignificant. If you specify evaluate or omit this parameter, the alarm is\u003cbr/\u003ealways evaluated and possibly changes state no matter how many data points\u003cbr/\u003eare available. For more information, see Percentile-Based CloudWatch Alarms\u003cbr/\u003eand Low Data Samples (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: evaluate | ignore |\n| \u003cstrong\u003eevaluationPeriods\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of periods over which data is compared to the specified threshold.\u003cbr/\u003eIf you are setting an alarm that requires that a number of consecutive data\u003cbr/\u003epoints be breaching to trigger the alarm, this value specifies that number.\u003cbr/\u003eIf you are setting an \u0026ldquo;M out of N\u0026rdquo; alarm, this value is the N.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn alarm\u0026rsquo;s total current evaluation period can be no longer than one day,\u003cbr/\u003eso this number multiplied by Period cannot be more than 86,400 seconds. |\n| \u003cstrong\u003eextendedStatistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe extended statistic for the metric specified in MetricName. When you call\u003cbr/\u003ePutMetricAlarm and specify a MetricName, you must specify either Statistic\u003cbr/\u003eor ExtendedStatistic but not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify ExtendedStatistic, the following are valid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * p90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * tm90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * tc90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ts90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wm90\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IQM\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PR(n:m) where n and m are values of the metric\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TC(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TM(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * TS(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * WM(X%:X%) where X is between 10 and 90 inclusive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about these extended statistics, see CloudWatch statistics\u003cbr/\u003edefinitions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html). |\n| \u003cstrong\u003einsufficientDataActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to the INSUFFICIENT_DATA\u003cbr/\u003estate from any other state. Each action is specified as an Amazon Resource\u003cbr/\u003eName (ARN). Valid values:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |\n| \u003cstrong\u003einsufficientDataActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003emetricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the metric associated with the alarm. For each PutMetricAlarm\u003cbr/\u003eoperation, you must specify either MetricName or a Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are creating an alarm based on a math expression, you cannot specify\u003cbr/\u003ethis parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic,\u003cbr/\u003eor ExtendedStatistic parameters. Instead, you specify all this information\u003cbr/\u003ein the Metrics array. |\n| \u003cstrong\u003emetrics\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of MetricDataQuery structures that enable you to create an alarm\u003cbr/\u003ebased on the result of a metric math expression. For each PutMetricAlarm\u003cbr/\u003eoperation, you must specify either MetricName or a Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach item in the Metrics array either retrieves a metric or performs a math\u003cbr/\u003eexpression.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOne item in the Metrics array is the expression that the alarm watches. You\u003cbr/\u003edesignate this expression by setting ReturnData to true for this object in\u003cbr/\u003ethe array. For more information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use the Metrics parameter, you cannot include the Namespace, MetricName,\u003cbr/\u003eDimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm\u003cbr/\u003ein the same operation. Instead, you retrieve the metrics you are using in\u003cbr/\u003eyour math expression as part of the Metrics array. |\n| \u003cstrong\u003emetrics.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure is used in both GetMetricData and PutMetricAlarm. The supported\nuse of this structure is different for those two operations.\u003c/p\u003e\n\u003cp\u003eWhen used in GetMetricData, it indicates the metric data to return, and whether\nthis call is just retrieving a batch set of data for one metric, or is performing\na Metrics Insights query or a math expression. A single GetMetricData call\ncan include up to 500 MetricDataQuery structures.\u003c/p\u003e\n\u003cp\u003eWhen used in PutMetricAlarm, it enables you to create an alarm based on a\nmetric math expression. Each MetricDataQuery in the array specifies either\na metric to retrieve, or a math expression to be performed on retrieved metrics.\nA single PutMetricAlarm call can include up to 20 MetricDataQuery structures\nin the array. The 20 structures can include as many as 10 structures that\ncontain a MetricStat parameter to retrieve a metric, and as many as 10 structures\nthat contain the Expression parameter to perform a math expression. Of those\nExpression structures, one must have true as the value for ReturnData. The\nresult of this expression is the value the alarm watches.\u003c/p\u003e\n\u003cp\u003eAny expression used in a PutMetricAlarm operation must return a single time\nseries. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)\nin the Amazon CloudWatch User Guide.\u003c/p\u003e\n\u003cp\u003eSome of the parameters of this structure also have different uses whether\nyou are using this structure in a GetMetricData operation or a PutMetricAlarm\noperation. These differences are explained in the following parameter list. || \u003cstrong\u003emetrics.[].accountID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].label\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure defines the metric to be returned, along with the statistics,\u003cbr/\u003eperiod, and units. |\n| \u003cstrong\u003emetrics.[].metricStat.metric\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a specific metric. |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA dimension is a name/value pair that is part of the identity of a metric.\nBecause dimensions are part of the unique identifier for a metric, whenever\nyou add a unique name/value pair to one of your metrics, you are creating\na new variation of that metric. For example, many Amazon EC2 metrics publish\nInstanceId as a dimension name, and the actual instance ID as the value for\nthat dimension.\u003c/p\u003e\n\u003cp\u003eYou can assign up to 30 dimensions to a metric. || \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.metric.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.period\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.stat\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].metricStat.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].period\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003emetrics.[].returnData\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name for the alarm. This name must be unique within the Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe name must contain only UTF-8 characters, and can\u0026rsquo;t contain ASCII control\u003cbr/\u003echaracters |\n| \u003cstrong\u003enamespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace for the metric associated specified in MetricName. |\n| \u003cstrong\u003eoKActions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe actions to execute when this alarm transitions to an OK state from any\u003cbr/\u003eother state. Each action is specified as an Amazon Resource Name (ARN). Valid\u003cbr/\u003evalues:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEC2 actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:stop\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:terminate\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:reboot\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:automate:region:ec2:recover\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAutoscaling action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSNS notification action:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSSM integration actions:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |\n| \u003cstrong\u003eoKActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eperiod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe length, in seconds, used each time the metric specified in MetricName\u003cbr/\u003eis evaluated. Valid values are 10, 30, and any multiple of 60.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePeriod is required for alarms based on static thresholds. If you are creating\u003cbr/\u003ean alarm based on a metric math expression, you specify the period for each\u003cbr/\u003emetric within the objects in the Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBe sure to specify 10 or 30 only for metrics that are stored by a PutMetricData\u003cbr/\u003ecall with a StorageResolution of 1. If you specify a period of 10 or 30 for\u003cbr/\u003ea metric that does not have sub-minute resolution, the alarm still attempts\u003cbr/\u003eto gather data at the period rate that you specify. In this case, it does\u003cbr/\u003enot receive data for the attempts that do not correspond to a one-minute\u003cbr/\u003edata resolution, and the alarm might often lapse into INSUFFICENT_DATA status.\u003cbr/\u003eSpecifying 10 or 30 also sets this alarm as a high-resolution alarm, which\u003cbr/\u003ehas a higher charge than other alarms. For more information about pricing,\u003cbr/\u003esee Amazon CloudWatch Pricing (https://aws.amazon.com/cloudwatch/pricing/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn alarm\u0026rsquo;s total current evaluation period can be no longer than one day,\u003cbr/\u003eso Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds. |\n| \u003cstrong\u003estatistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe statistic for the metric specified in MetricName, other than percentile.\u003cbr/\u003eFor percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm\u003cbr/\u003eand specify a MetricName, you must specify either Statistic or ExtendedStatistic,\u003cbr/\u003ebut not both. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pairs to associate with the alarm. You can associate\u003cbr/\u003eas many as 50 tags with an alarm. To be able to associate tags with the alarm\u003cbr/\u003ewhen you create the alarm, you must have the cloudwatch:TagResource permission.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags can help you organize and categorize your resources. You can also use\u003cbr/\u003ethem to scope user permissions by granting a user permission to access or\u003cbr/\u003echange only resources with certain tag values.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are using this operation to update an existing alarm, any tags you\u003cbr/\u003especify in this parameter are ignored. To change the tags of an existing\u003cbr/\u003ealarm, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html)\u003cbr/\u003eor UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with a CloudWatch resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ethreshold\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003eThe value against which the specified statistic is compared.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for alarms based on static thresholds, but should\u003cbr/\u003enot be used for alarms based on anomaly detection models. |\n| \u003cstrong\u003ethresholdMetricID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf this is an alarm based on an anomaly detection model, make this value\u003cbr/\u003ematch the ID of the ANOMALY_DETECTION_BAND function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor an example of how to use this parameter, see the Anomaly Detection Model\u003cbr/\u003eAlarm example on this page.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your alarm uses this parameter, it cannot have Auto Scaling actions. |\n| \u003cstrong\u003etreatMissingData\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSets how this alarm is to handle missing data points. If TreatMissingData\u003cbr/\u003eis omitted, the default behavior of missing is used. For more information,\u003cbr/\u003esee Configuring How CloudWatch Alarms Treats Missing Data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid Values: breaching | notBreaching | ignore | missing\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlarms that evaluate metrics in the AWS/DynamoDB namespace always ignore\u003cbr/\u003emissing data even if you choose a different option for TreatMissingData.\u003cbr/\u003eWhen an AWS/DynamoDB metric has missing data, alarms that evaluate that metric\u003cbr/\u003eremain in their current state. |\n| \u003cstrong\u003eunit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unit of measure for the statistic. For example, the units for the Amazon\u003cbr/\u003eEC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes\u003cbr/\u003ethat an instance receives on all network interfaces. You can also specify\u003cbr/\u003ea unit when you create a custom metric. Units help provide conceptual meaning\u003cbr/\u003eto your data. Metric data points that specify a unit of measure, such as\u003cbr/\u003ePercent, are aggregated separately. If you are creating an alarm based on\u003cbr/\u003ea metric math expression, you can specify the unit for each metric (if needed)\u003cbr/\u003ewithin the objects in the Metrics array.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify Unit, CloudWatch retrieves all unit types that have\u003cbr/\u003ebeen published for the metric and attempts to evaluate the alarm. Usually,\u003cbr/\u003emetrics are published with only one unit, so the alarm works as intended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eHowever, if the metric is published with multiple types of units and you\u003cbr/\u003edon\u0026rsquo;t specify a unit, the alarm\u0026rsquo;s behavior is not defined and it behaves\u003cbr/\u003eunpredictably.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe recommend omitting Unit so that you don\u0026rsquo;t inadvertently specify an incorrect\u003cbr/\u003eunit that is not published for this metric. Doing so causes the alarm to\u003cbr/\u003ebe stuck in the INSUFFICIENT DATA state. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:124,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/model/",title:"Model",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Model"\u003esagemaker-controller/apis/v1alpha1#Model\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModel\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodels\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodel\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe properties of a model as returned by the Search (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_Search.html)\nAPI.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainers:\n- containerHostname: string\n environment: {}\n image: string\n imageConfig: \n repositoryAccessMode: string\n repositoryAuthConfig: \n repositoryCredentialsProviderARN: string\n inferenceSpecificationName: string\n mode: string\n modelDataSource: \n s3DataSource: \n compressionType: string\n modelAccessConfig: \n acceptEula: boolean\n s3DataType: string\n s3URI: string\n modelDataURL: string\n modelPackageName: string\n multiModelConfig: \n modelCacheSetting: string\nenableNetworkIsolation: boolean\nexecutionRoleARN: string\ninferenceExecutionConfig: \n mode: string\nmodelName: string\nprimaryContainer: \n containerHostname: string\n environment: {}\n image: string\n imageConfig: \n repositoryAccessMode: string\n repositoryAuthConfig: \n repositoryCredentialsProviderARN: string\n inferenceSpecificationName: string\n mode: string\n modelDataSource: \n s3DataSource: \n compressionType: string\n modelAccessConfig: \n acceptEula: boolean\n s3DataType: string\n s3URI: string\n modelDataURL: string\n modelPackageName: string\n multiModelConfig: \n modelCacheSetting: string\ntags:\n- key: string\n value: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the containers in the inference pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the container, as part of model definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the model container is in Amazon ECR or a private Docker\u003cbr/\u003eregistry accessible from your Amazon Virtual Private Cloud (VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAuthConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an authentication configuration for the private docker registry\u003cbr/\u003ewhere your model image is hosted. Specify a value for this property only\u003cbr/\u003eif you specified Vpc as the value for the RepositoryAccessMode field of the\u003cbr/\u003eImageConfig object that you passed to a call to CreateModel and the private\u003cbr/\u003eDocker registry where the model image is hosted requires authentication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].imageConfig.repositoryAuthConfig.repositoryCredentialsProviderARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].inferenceSpecificationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the location of ML model data to deploy. If specified, you must\u003cbr/\u003especify one and only one of the available data sources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 location of ML model data to deploy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.modelAccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration file to control access to the ML model. You can\u003cbr/\u003eexplicitly accept the model end-user license agreement (EULA) within the\u003cbr/\u003eModelAccessConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula)\u003cbr/\u003e section for more details on accepting the EULA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are an AutoML user, see the Optional Parameters section of Create\u003cbr/\u003e an AutoML job to fine-tune text generation models using the API for details\u003cbr/\u003e on How to set the EULA acceptance when fine-tuning a model using the AutoML\u003cbr/\u003e API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.modelAccessConfig.acceptEula\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].modelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].multiModelConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional configuration for hosting multi-model endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainers.[].multiModelConfig.modelCacheSetting\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIsolates the model container. No inbound or outbound network calls can be\u003cbr/\u003emade to or from the model container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role that SageMaker can assume\u003cbr/\u003eto access model artifacts and docker image for deployment on ML compute instances\u003cbr/\u003eor for batch transform jobs. Deploying on ML compute instances is part of\u003cbr/\u003emodel hosting. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceExecutionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies details of how containers in a multi-container endpoint are called.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceExecutionConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe location of the primary docker image containing inference code, associated\u003cbr/\u003eartifacts, and custom environment map that the inference code uses when the\u003cbr/\u003emodel is deployed for predictions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the model container is in Amazon ECR or a private Docker\u003cbr/\u003eregistry accessible from your Amazon Virtual Private Cloud (VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAuthConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an authentication configuration for the private docker registry\u003cbr/\u003ewhere your model image is hosted. Specify a value for this property only\u003cbr/\u003eif you specified Vpc as the value for the RepositoryAccessMode field of the\u003cbr/\u003eImageConfig object that you passed to a call to CreateModel and the private\u003cbr/\u003eDocker registry where the model image is hosted requires authentication.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.imageConfig.repositoryAuthConfig.repositoryCredentialsProviderARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.inferenceSpecificationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the location of ML model data to deploy. If specified, you must\u003cbr/\u003especify one and only one of the available data sources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the S3 location of ML model data to deploy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.modelAccessConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe access configuration file to control access to the ML model. You can\u003cbr/\u003eexplicitly accept the model end-user license agreement (EULA) within the\u003cbr/\u003eModelAccessConfig.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are a Jumpstart user, see the End-user license agreements (https://docs.aws.amazon.com/sagemaker/latest/dg/jumpstart-foundation-models-choose.html#jumpstart-foundation-models-choose-eula)\u003cbr/\u003e section for more details on accepting the EULA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you are an AutoML user, see the Optional Parameters section of Create\u003cbr/\u003e an AutoML job to fine-tune text generation models using the API for details\u003cbr/\u003e on How to set the EULA acceptance when fine-tuning a model using the AutoML\u003cbr/\u003e API (https://docs.aws.amazon.com/sagemaker/latest/dg/autopilot-create-experiment-finetune-llms.html#autopilot-llms-finetuning-api-optional-params).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.modelAccessConfig.acceptEula\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.modelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.multiModelConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies additional configuration for hosting multi-model endpoints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryContainer.multiModelConfig.modelCacheSetting\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)\u003cbr/\u003eobject that specifies the VPC that you want your model to connect to. Control\u003cbr/\u003eaccess to and from your model container by configuring the VPC. VpcConfig\u003cbr/\u003eis used in hosting services and in batch transform. For more information,\u003cbr/\u003esee Protect Endpoints by Using an Amazon Virtual Private Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/host-vpc.html)\u003cbr/\u003eand Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private\u003cbr/\u003eCloud (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-vpc.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:125,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelbiasjobdefinition/",title:"ModelBiasJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelBiasJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelBiasJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelBiasJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelBiasJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelbiasjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelbiasjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelBiasAppSpecification: \n configURI: string\n environment: {}\n imageURI: string\nmodelBiasBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelBiasJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n groundTruthS3Input: \n s3URI: string\nmodelBiasJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the bias job definition. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the model bias job to run a specified Docker container image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.configURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe baseline configuration for a model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInputs for the model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.groundTruthS3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ground truth labels for the dataset used for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobInput.groundTruthS3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelBiasJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a model bias job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:126,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/",title:"ModelExplainabilityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelExplainabilityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelExplainabilityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelExplainabilityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelExplainabilityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelexplainabilityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelexplainabilityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelExplainabilityAppSpecification: \n configURI: string\n environment: {}\n imageURI: string\nmodelExplainabilityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelExplainabilityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\nmodelExplainabilityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model explainability job definition. The name must be unique\u003cbr/\u003ewithin an Amazon Web Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the model explainability job to run a specified Docker container\u003cbr/\u003eimage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.configURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe baseline configuration for a model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInputs for the model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelExplainabilityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a model explainability job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:127,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelpackage/",title:"ModelPackage",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelPackage"\u003esagemaker-controller/apis/v1alpha1#ModelPackage\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackages\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA versioned model that can be deployed for SageMaker inference.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eadditionalInferenceSpecifications:\n containers:\n additionalS3DataSource: \n compressionType: string\n s3DataType: string\n s3URI: string\n containerHostname: string\n environment: {}\n framework: string\n frameworkVersion: string\n image: string\n imageDigest: string\n modelDataURL: string\n modelInput: \n dataInputConfig: string\n nearestModelName: string\n productID: string\n description: string\n name: string\n supportedContentTypes:\n - string\n supportedRealtimeInferenceInstanceTypes:\n - string\n supportedResponseMIMETypes:\n - string\n supportedTransformInstanceTypes:\n - string\napprovalDescription: string\ncertifyForMarketplace: boolean\nclientToken: string\ncustomerMetadataProperties: {}\ndomain: string\ndriftCheckBaselines: \n bias: \n configFile: \n contentDigest: string\n contentType: string\n s3URI: string\n postTrainingConstraints: \n contentDigest: string\n contentType: string\n s3URI: string\n preTrainingConstraints: \n contentDigest: string\n contentType: string\n s3URI: string\n explainability: \n configFile: \n contentDigest: string\n contentType: string\n s3URI: string\n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n modelDataQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\n modelQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\ninferenceSpecification: \n containers:\n additionalS3DataSource: \n compressionType: string\n s3DataType: string\n s3URI: string\n containerHostname: string\n environment: {}\n framework: string\n frameworkVersion: string\n image: string\n imageDigest: string\n modelDataURL: string\n modelInput: \n dataInputConfig: string\n nearestModelName: string\n productID: string\n supportedContentTypes:\n - string\n supportedRealtimeInferenceInstanceTypes:\n - string\n supportedResponseMIMETypes:\n - string\n supportedTransformInstanceTypes:\n - string\nmetadataProperties: \n commitID: string\n generatedBy: string\n projectID: string\n repository: string\nmodelApprovalStatus: string\nmodelMetrics: \n bias: \n postTrainingReport: \n contentDigest: string\n contentType: string\n s3URI: string\n preTrainingReport: \n contentDigest: string\n contentType: string\n s3URI: string\n report: \n contentDigest: string\n contentType: string\n s3URI: string\n explainability: \n report: \n contentDigest: string\n contentType: string\n s3URI: string\n modelDataQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\n modelQuality: \n constraints: \n contentDigest: string\n contentType: string\n s3URI: string\n statistics: \n contentDigest: string\n contentType: string\n s3URI: string\nmodelPackageDescription: string\nmodelPackageGroupName: string\nmodelPackageName: string\nsamplePayloadURL: string\nskipModelValidation: string\nsourceAlgorithmSpecification: \n sourceAlgorithms:\n - algorithmName: string\n modelDataURL: string\ntags:\n- key: string\n value: string\ntask: string\nvalidationSpecification: \n validationProfiles:\n - profileName: string\n transformJobDefinition: \n batchStrategy: string\n environment: {}\n maxConcurrentTransforms: integer\n maxPayloadInMB: integer\n transformInput: \n compressionType: string\n contentType: string\n dataSource: \n s3DataSource: \n s3DataType: string\n s3URI: string\n splitType: string\n transformOutput: \n accept: string\n assembleWith: string\n kmsKeyID: string\n s3OutputPath: string\n transformResources: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n validationRole: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of additional Inference Specification objects. Each additional Inference\u003cbr/\u003eSpecification specifies artifacts based on this model package that can be\u003cbr/\u003eused on inference endpoints. Generally used with SageMaker Neo to store the\u003cbr/\u003ecompiled artifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure of additional Inference Specification. Additional Inference Specification\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003especifies details about inference jobs that can be run with models based\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eon this model package\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the Docker container for the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].additionalS3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].framework\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].frameworkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].imageDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].modelInput.dataInputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].nearestModelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].containers.[].productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedRealtimeInferenceInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedResponseMIMETypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalInferenceSpecifications.[].supportedTransformInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecertifyForMarketplace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eWhether to certify the model package for listing on Amazon Web Services Marketplace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional for unversioned models, and does not apply to\u003cbr/\u003eversioned models.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique token that guarantees that the call to this API is idempotent.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerMetadataProperties\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata properties associated with the model package versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomain\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe machine learning domain of your model package and its components. Common\u003cbr/\u003emachine learning domains include computer vision and natural language processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check baselines that can be used when the model monitor\u003cbr/\u003eis set using the model package. For more information, see the topic on Drift\u003cbr/\u003eDetection against Previous Baselines in SageMaker Pipelines (https://docs.aws.amazon.com/sagemaker/latest/dg/pipelines-quality-clarify-baseline-lifecycle.html#pipelines-quality-clarify-baseline-drift-detection)\u003cbr/\u003ein the Amazon SageMaker Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check bias baselines that can be used when the model\u003cbr/\u003emonitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details regarding the file source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.configFile.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.postTrainingConstraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.bias.preTrainingConstraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check explainability baselines that can be used when\u003cbr/\u003ethe model monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details regarding the file source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.configFile.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.explainability.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check data quality baselines that can be used when the\u003cbr/\u003emodel monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelDataQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the drift check model quality baselines that can be used when\u003cbr/\u003ethe model monitor is set using the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edriftCheckBaselines.modelQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies details about inference jobs that can be run with models based\u003cbr/\u003eon this model package, including the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The Amazon ECR paths of containers that contain the inference code and\u003cbr/\u003e model artifacts.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The instance types that the model package supports for transform jobs\u003cbr/\u003e and real-time endpoints used for inference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The input and output content formats that the model package supports\u003cbr/\u003e for inference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the Docker container for the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].additionalS3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].containerHostname\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].framework\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].frameworkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].image\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].imageDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].modelInput.dataInputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].nearestModelName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.containers.[].productID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedContentTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedContentTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedRealtimeInferenceInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedResponseMIMETypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einferenceSpecification.supportedTransformInstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.commitID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.generatedBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.projectID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emetadataProperties.repository\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelApprovalStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether the model is approved for deployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional for versioned models, and does not apply to unversioned\u003cbr/\u003emodels.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor versioned models, the value of this parameter must be set to Approved\u003cbr/\u003eto deploy the model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that contains model metrics reports.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains bias metrics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.postTrainingReport.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.preTrainingReport.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.bias.report.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains explainability metrics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.explainability.report.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eData quality constraints and statistics for a model.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelDataQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eModel quality statistics and constraints.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.constraints.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the metrics source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.contentDigest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelMetrics.modelQuality.statistics.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the model package group that this\u003cbr/\u003emodel version belongs to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for versioned models, and does not apply to unversioned\u003cbr/\u003emodels.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model package. The name must have 1 to 63 characters. Valid\u003cbr/\u003echaracters are a-z, A-Z, 0-9, and - (hyphen).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for unversioned models. It is not applicable to\u003cbr/\u003eversioned models.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esamplePayloadURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Simple Storage Service (Amazon S3) path where the sample payload\u003cbr/\u003eis stored. This path must point to a single gzip compressed tar archive (.tar.gz\u003cbr/\u003esuffix). This archive can hold multiple files that are all equally used in\u003cbr/\u003ethe load test. Each file in the archive must satisfy the size constraints\u003cbr/\u003eof the InvokeEndpoint (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_runtime_InvokeEndpoint.html#API_runtime_InvokeEndpoint_RequestSyntax)\u003cbr/\u003ecall.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eskipModelValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates if you want to skip model validation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the algorithm that was used to create the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an algorithm that was used to create the model package. The algorithm\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emust be either an algorithm resource in your SageMaker account or an algorithm\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein Amazon Web Services Marketplace that you are subscribed to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceAlgorithmSpecification.sourceAlgorithms.[].modelDataURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key value pairs associated with the model. For more information,\u003cbr/\u003esee Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you supply ModelPackageGroupName, your model package belongs to the model\u003cbr/\u003egroup you specify and uses the tags associated with the model group. In this\u003cbr/\u003ecase, you cannot supply a tag argument.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etask\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe machine learning task your model package accomplishes. Common machine\u003cbr/\u003elearning tasks include object detection and image classification. The following\u003cbr/\u003etasks are supported by Inference Recommender: \u0026ldquo;IMAGE_CLASSIFICATION\u0026rdquo; | \u0026ldquo;OBJECT_DETECTION\u0026rdquo;\u003cbr/\u003e| \u0026ldquo;TEXT_GENERATION\u0026rdquo; |\u0026ldquo;IMAGE_SEGMENTATION\u0026rdquo; | \u0026ldquo;FILL_MASK\u0026rdquo; | \u0026ldquo;CLASSIFICATION\u0026rdquo;\u003cbr/\u003e| \u0026ldquo;REGRESSION\u0026rdquo; | \u0026ldquo;OTHER\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecify \u0026ldquo;OTHER\u0026rdquo; if none of the tasks listed fit your use case. |\n| \u003cstrong\u003evalidationSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies configurations for one or more transform jobs that SageMaker runs\u003cbr/\u003eto test the model package. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains data, such as the inputs and targeted instance types that are used\nin the process of validating the model package.\u003c/p\u003e\n\u003cp\u003eThe data provided in the validation profile is made available to your buyers\non Amazon Web Services Marketplace. || \u003cstrong\u003evalidationSpecification.validationProfiles.[].profileName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the input needed to run a transform job using the inference specification\u003cbr/\u003especified in the algorithm. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.batchStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.environment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.maxConcurrentTransforms\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.maxPayloadInMB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the input source of a transform job and the way the transform job\u003cbr/\u003econsumes it. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformInput.splitType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of a transform job. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.accept\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.assembleWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformOutput.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including ML instance types and ML instance count,\u003cbr/\u003eto use for transform job. |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationProfiles.[].transformJobDefinition.transformResources.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evalidationSpecification.validationRole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\nmodelPackageStatus: string\nmodelPackageStatusDetails: \n imageScanStatuses:\n - failureReason: string\n name: string\n status: string\n validationStatuses:\n - failureReason: string\n name: string\n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp specifying when the model package was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe last time that the model package was modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the current status of the model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the overall status of a model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.imageScanStatuses.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the overall status of a model package.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageStatusDetails.validationStatuses.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:128,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelpackagegroup/",title:"ModelPackageGroup",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelPackageGroup"\u003esagemaker-controller/apis/v1alpha1#ModelPackageGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelPackageGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackagegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelpackagegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA group of versioned models in the model registry.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emodelPackageGroupDescription: string\nmodelPackageGroupName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key value pairs associated with the model group. For more information,\u003cbr/\u003esee Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)\u003cbr/\u003ein the Amazon Web Services General Reference Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nmodelPackageGroupStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelPackageGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the model group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:129,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/modelqualityjobdefinition/",title:"ModelQualityJobDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ModelQualityJobDefinition"\u003esagemaker-controller/apis/v1alpha1#ModelQualityJobDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelQualityJobDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eModelQualityJobDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelqualityjobdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emodelqualityjobdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ejobDefinitionName: string\njobResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nmodelQualityAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n environment: {}\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n problemType: string\n recordPreprocessorSourceURI: string\nmodelQualityBaselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\nmodelQualityJobInput: \n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n groundTruthS3Input: \n s3URI: string\nmodelQualityJobOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobDefinitionName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the monitoring job definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ejobResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container that runs the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.imageURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.problemType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the constraints and baselines for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityBaselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of the inputs that are monitored. Currently endpoints are supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInput object for the endpoint\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.groundTruthS3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ground truth labels for the dataset used for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobInput.groundTruthS3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelQualityJobOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the network configuration for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:130,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/monitoringschedule/",title:"MonitoringSchedule",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#MonitoringSchedule"\u003esagemaker-controller/apis/v1alpha1#MonitoringSchedule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMonitoringSchedule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMonitoringScheduleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emonitoringschedules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emonitoringschedule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA schedule for a model monitoring job. For information about model monitor,\nsee Amazon SageMaker Model Monitor (https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emonitoringScheduleConfig: \n monitoringJobDefinition: \n baselineConfig: \n baseliningJobName: string\n constraintsResource: \n s3URI: string\n statisticsResource: \n s3URI: string\n environment: {}\n monitoringAppSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n imageURI: string\n postAnalyticsProcessorSourceURI: string\n recordPreprocessorSourceURI: string\n monitoringInputs:\n endpointInput: \n endTimeOffset: string\n endpointName: string\n excludeFeaturesAttribute: string\n featuresAttribute: string\n inferenceAttribute: string\n localPath: string\n probabilityAttribute: string\n probabilityThresholdAttribute: number\n s3DataDistributionType: string\n s3InputMode: string\n startTimeOffset: string\n monitoringOutputConfig: \n kmsKeyID: string\n monitoringOutputs:\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\n monitoringResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\n networkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n roleARN: string\n stoppingCondition: \n maxRuntimeInSeconds: integer\n monitoringJobDefinitionName: string\n monitoringType: string\n scheduleConfig: \n dataAnalysisEndTime: string\n dataAnalysisStartTime: string\n scheduleExpression: string\nmonitoringScheduleName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration object that specifies the monitoring schedule and defines\u003cbr/\u003ethe monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for monitoring constraints and monitoring statistics. These\u003cbr/\u003ebaseline resources are compared against the results of the current job from\u003cbr/\u003ethe series of jobs scheduled to collect data periodically.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.baseliningJobName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraints resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.constraintsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe statistics resource for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.baselineConfig.statisticsResource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.environment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer image configuration object for the monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.postAnalyticsProcessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringAppSpecification.recordPreprocessorSourceURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inputs for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.excludeFeaturesAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.featuresAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.inferenceAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.probabilityThresholdAttribute\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringInputs.[].endpointInput.startTimeOffset\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output configuration for monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe output object for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringOutputConfig.monitoringOutputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources to deploy for a monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run model monitoring jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.monitoringResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a job, such as network traffic encryption between\u003cbr/\u003econtainers, whether to allow inbound and outbound network calls to and from\u003cbr/\u003econtainers, and the VPC subnets and security groups to use for VPC-enabled\u003cbr/\u003ejobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.networkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.stoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA time limit for how long the monitoring job is allowed to run before stopping.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinition.stoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.monitoringType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration details about the monitoring schedule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.dataAnalysisEndTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.dataAnalysisStartTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleConfig.scheduleConfig.scheduleExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the monitoring schedule. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region within an Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfailureReason: string\nlastModifiedTime: string\nlastMonitoringExecutionSummary: \n creationTime: string\n endpointName: string\n failureReason: string\n lastModifiedTime: string\n monitoringExecutionStatus: string\n monitoringJobDefinitionName: string\n monitoringScheduleName: string\n monitoringType: string\n processingJobARN: string\n scheduledTime: string\nmonitoringScheduleStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the monitoring job was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string, up to one KB in size, that contains the reason a monitoring job\u003cbr/\u003efailed, if it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time at which the monitoring job was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes metadata on the last execution to run, if there was one.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.creationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.endpointName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.failureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringExecutionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringJobDefinitionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringScheduleName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.monitoringType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.processingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastMonitoringExecutionSummary.scheduledTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emonitoringScheduleStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of an monitoring job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:131,href:"https://aws-controllers-k8s.github.io/community/reference/efs/v1alpha1/mounttarget/",title:"MountTarget",description:null,content:'\u003cp\u003e\u003ccode\u003eefs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/efs-controller/apis/v1alpha1#MountTarget"\u003eefs-controller/apis/v1alpha1#MountTarget\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMountTarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eMountTargetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emounttargets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003emounttarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003efileSystemID: string\nfileSystemRef: \n from: \n name: string\nipAddress: string\nsecurityGroupRefs:\n from: \n name: string\nsecurityGroups:\n- string\nsubnetID: string\nsubnetRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the file system for which to create the mount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eValid IPv4 address within the address range of the specified subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eUp to five VPC security group IDs, of the form sg-xxxxxxxx. These must be\u003cbr/\u003efor the same VPC as subnet specified. |\n| \u003cstrong\u003esecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the subnet to add the mount target in. For One Zone file systems,\u003cbr/\u003euse the subnet that is associated with the file system\u0026rsquo;s Availability Zone. |\n| \u003cstrong\u003esubnetRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003esubnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003esubnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZoneID: string\navailabilityZoneName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlifeCycleState: string\nmountTargetID: string\nnetworkInterfaceID: string\nownerID: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique and consistent identifier of the Availability Zone that the mount\u003cbr/\u003etarget resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region\u003cbr/\u003eand it has the same location in every Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Availability Zone in which the mount target is located. Availability\u003cbr/\u003eZones are independently mapped to names for each Amazon Web Services account.\u003cbr/\u003eFor example, the Availability Zone us-east-1a for your Amazon Web Services\u003cbr/\u003eaccount might not be the same location as us-east-1a for another Amazon Web\u003cbr/\u003eServices account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifeCycleState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eLifecycle state of the mount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emountTargetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSystem-assigned mount target ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the network interface that Amazon EFS created when it created the\u003cbr/\u003emount target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAmazon Web Services account ID that owns the resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe virtual private cloud (VPC) ID that the mount target is configured in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:132,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/natgateway/",title:"NATGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#NATGateway"\u003eec2-controller/apis/v1alpha1#NATGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNATGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNATGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enatgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enatgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a NAT gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eallocationID: string\nallocationRef: \n from: \n name: string\nconnectivityType: string\nsubnetID: string\nsubnetRef: \n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e[Public NAT gateways only] The allocation ID of an Elastic IP address to\u003cbr/\u003eassociate with the NAT gateway. You cannot specify an Elastic IP address\u003cbr/\u003ewith a private NAT gateway. If the Elastic IP address is associated with\u003cbr/\u003eanother resource, you must first disassociate it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallocationRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econnectivityType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the NAT gateway supports public or private connectivity.\u003cbr/\u003eThe default is public connectivity.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe subnet in which to create the NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateTime: string\ndeleteTime: string\nfailureCode: string\nfailureMessage: string\nnatGatewayAddresses:\n- allocationID: string\n networkInterfaceID: string\n privateIP: string\n publicIP: string\nnatGatewayID: string\nprovisionedBandwidth: \n provisionTime: string\n provisioned: string\n requestTime: string\n requested: string\n status: string\nstate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time the NAT gateway was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeleteTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time the NAT gateway was deleted, if applicable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the NAT gateway could not be created, specifies the error code for the\u003cbr/\u003efailure. (InsufficientFreeAddressesInSubnet\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the NAT gateway could not be created, specifies the error message for\u003cbr/\u003ethe failure, that corresponds to the error code.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InsufficientFreeAddressesInSubnet: \u0026ldquo;Subnet has insufficient free\u003cbr/\u003e addresses to create this NAT gateway\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For Gateway.NotAttached: \u0026ldquo;Network vpc-xxxxxxxx has no Internet gateway\u003cbr/\u003e attached\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InvalidAllocationID.NotFound: \u0026ldquo;Elastic IP address eipalloc-xxxxxxxx\u003cbr/\u003e could not be associated with this NAT gateway\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For Resource.AlreadyAssociated: \u0026ldquo;Elastic IP address eipalloc-xxxxxxxx\u003cbr/\u003e is already associated\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InternalError: \u0026ldquo;Network interface eni-xxxxxxxx, created and used\u003cbr/\u003e internally by this NAT gateway is in an invalid state. Please try again.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For InvalidSubnetID.NotFound: \u0026ldquo;The specified subnet subnet-xxxxxxxx\u003cbr/\u003e does not exist or could not be found.\u0026rdquo;\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IP addresses and network interface associated with\u003cbr/\u003ethe NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the IP addresses and network interface associated with a NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].privateIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayAddresses.[].publicIP\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enatGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the NAT gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReserved. If you need to sustain traffic greater than the documented limits\u003cbr/\u003e(https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html),\u003cbr/\u003econtact us through the Support Center (https://console.aws.amazon.com/support/home?).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.provisionTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.provisioned\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.requestTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.requested\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedBandwidth.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the NAT gateway.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * pending: The NAT gateway is being created and is not ready to process\u003cbr/\u003e traffic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * failed: The NAT gateway could not be created. Check the failureCode\u003cbr/\u003e and failureMessage fields for the reason.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * available: The NAT gateway is able to process traffic. This status remains\u003cbr/\u003e until you delete the NAT gateway, and does not indicate the health of\u003cbr/\u003e the NAT gateway.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * deleting: The NAT gateway is in the process of being terminated and\u003cbr/\u003e may still be processing traffic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * deleted: The NAT gateway has been terminated and is no longer processing\u003cbr/\u003e traffic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC in which the NAT gateway is located.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:133,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/networkacl/",title:"NetworkACL",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#NetworkACL"\u003eec2-controller/apis/v1alpha1#NetworkACL\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNetworkACL\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNetworkACLList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enetworkacls\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enetworkacl\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a network ACL.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassociations:\n- networkACLAssociationID: string\n networkACLID: string\n subnetID: string\n subnetRef: \n from: \n name: string\nentries:\n- cidrBlock: string\n egress: boolean\n icmpTypeCode: \n code: integer\n type_: integer\n ipv6CIDRBlock: string\n portRange: \n from: integer\n to: integer\n protocol: string\n ruleAction: string\n ruleNumber: integer\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a network ACL and a subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].networkACLID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an entry in a network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].egress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].icmpTypeCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the ICMP type and code.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].icmpTypeCode.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**entries.[].icmpTypeCode.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a range of ports.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].portRange.to\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].protocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ruleAction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eentries.[].ruleNumber\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nisDefault: boolean\nownerID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisDefault\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is the default network ACL for the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the network ACL.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:134,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/nodegroup/",title:"Nodegroup",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#Nodegroup"\u003eeks-controller/apis/v1alpha1#Nodegroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNodegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNodegroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enodegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enodegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing an Amazon EKS managed node group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamiType: string\ncapacityType: string\nclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\ndiskSize: integer\ninstanceTypes:\n- string\nlabels: {}\nlaunchTemplate: \n id: string\n name: string\n version: string\nname: string\nnodeRole: string\nnodeRoleRef: \n from: \n name: string\nreleaseVersion: string\nremoteAccess: \n ec2SshKey: string\n sourceSecurityGroupRefs:\n from: \n name: string\n sourceSecurityGroups:\n - string\nscalingConfig: \n desiredSize: integer\n maxSize: integer\n minSize: integer\nsubnetRefs:\n from: \n name: string\nsubnets:\n- string\ntags: {}\ntaints:\n- effect: string\n key: string\n value: string\nupdateConfig: \n maxUnavailable: integer\n maxUnavailablePercentage: integer\nversion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamiType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AMI type for your node group. If you specify launchTemplate, and your\u003cbr/\u003elaunch template uses a custom AMI, then don\u0026rsquo;t specify amiType, or the node\u003cbr/\u003egroup deployment will fail. If your launch template uses a Windows custom\u003cbr/\u003eAMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the\u003cbr/\u003eaws-auth ConfigMap. For more information about using launch templates with\u003cbr/\u003eAmazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe capacity type for your node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ediskSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe root device disk size (in GiB) for your node group instances. The default\u003cbr/\u003edisk size is 20 GiB for Linux and Bottlerocket. The default disk size is\u003cbr/\u003e50 GiB for Windows. If you specify launchTemplate, then don\u0026rsquo;t specify diskSize,\u003cbr/\u003eor the node group deployment will fail. For more information about using\u003cbr/\u003elaunch templates with Amazon EKS, see Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecify the instance types for a node group. If you specify a GPU instance\u003cbr/\u003etype, make sure to also specify an applicable GPU AMI type with the amiType\u003cbr/\u003eparameter. If you specify launchTemplate, then you can specify zero or one\u003cbr/\u003einstance type in your launch template or you can specify 0-20 instance types\u003cbr/\u003efor instanceTypes. If however, you specify an instance type in your launch\u003cbr/\u003etemplate and specify any instanceTypes, the node group deployment will fail.\u003cbr/\u003eIf you don\u0026rsquo;t specify an instance type in a launch template or for instanceTypes,\u003cbr/\u003ethen t3.medium is used, by default. If you specify Spot for capacityType,\u003cbr/\u003ethen we recommend specifying multiple values for instanceTypes. For more\u003cbr/\u003einformation, see Managed node group capacity types (https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types)\u003cbr/\u003eand Launch template support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a node group\u0026rsquo;s launch template specification. If specified,\u003cbr/\u003ethen do not specify instanceTypes, diskSize, or remoteAccess and make sure\u003cbr/\u003ethat the launch template meets the requirements in launchTemplateSpecification.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elaunchTemplate.version\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique name to give your node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to associate with your node\u003cbr/\u003egroup. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web\u003cbr/\u003eServices APIs on your behalf. Nodes receive permissions for these API calls\u003cbr/\u003ethrough an IAM instance profile and associated policies. Before you can launch\u003cbr/\u003enodes and register them into a cluster, you must create an IAM role for those\u003cbr/\u003enodes to use when they are launched. For more information, see Amazon EKS\u003cbr/\u003enode IAM role (https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html)\u003cbr/\u003ein the Amazon EKS User Guide . If you specify launchTemplate, then don\u0026rsquo;t\u003cbr/\u003especify IamInstanceProfile (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html)\u003cbr/\u003ein your launch template, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereleaseVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AMI version of the Amazon EKS optimized AMI to use with your node group.\u003cbr/\u003eBy default, the latest available AMI version for the node group\u0026rsquo;s current\u003cbr/\u003eKubernetes version is used. For information about Linux versions, see Amazon\u003cbr/\u003eEKS optimized Amazon Linux AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-linux-ami-versions.html)\u003cbr/\u003ein the Amazon EKS User Guide. Amazon EKS managed node groups support the\u003cbr/\u003eNovember 2022 and later releases of the Windows AMIs. For information about\u003cbr/\u003eWindows versions, see Amazon EKS optimized Windows AMI versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you specify launchTemplate, and your launch template uses a custom AMI,\u003cbr/\u003ethen don\u0026rsquo;t specify releaseVersion, or the node group deployment will fail.\u003cbr/\u003eFor more information about using launch templates with Amazon EKS, see Launch\u003cbr/\u003etemplate support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe remote access configuration to use with your node group. For Linux, the\u003cbr/\u003eprotocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate,\u003cbr/\u003ethen don\u0026rsquo;t specify remoteAccess, or the node group deployment will fail.\u003cbr/\u003eFor more information about using launch templates with Amazon EKS, see Launch\u003cbr/\u003etemplate support (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.ec2SshKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReference field for SourceSecurityGroups\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **remoteAccess.sourceSecurityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003eremoteAccess.sourceSecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eremoteAccess.sourceSecurityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eremoteAccess.sourceSecurityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003escalingConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe scaling configuration details for the Auto Scaling group that is created\u003cbr/\u003efor your node group. |\n| \u003cstrong\u003escalingConfig.desiredSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003escalingConfig.maxSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003escalingConfig.minSize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe subnets to use for the Auto Scaling group that is created for your node\u003cbr/\u003egroup. If you specify launchTemplate, then don\u0026rsquo;t specify SubnetId (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html)\u003cbr/\u003ein your launch template, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide. |\n| \u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources. |\n| \u003cstrong\u003etaints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Kubernetes taints to be applied to the nodes in the node group. For more\u003cbr/\u003einformation, see Node taints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html). |\n| \u003cstrong\u003etaints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA property that allows a node to repel a Pod. For more information, see Node\ntaints on managed node groups (https://docs.aws.amazon.com/eks/latest/userguide/node-taints-managed-node-groups.html)\nin the Amazon EKS User Guide. || \u003cstrong\u003etaints.[].effect\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaints.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaints.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eupdateConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe node group update configuration. |\n| \u003cstrong\u003eupdateConfig.maxUnavailable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eupdateConfig.maxUnavailablePercentage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Kubernetes version to use for your managed nodes. By default, the Kubernetes\u003cbr/\u003eversion of the cluster is used, and this is the only accepted specified value.\u003cbr/\u003eIf you specify launchTemplate, and your launch template uses a custom AMI,\u003cbr/\u003ethen don\u0026rsquo;t specify version, or the node group deployment will fail. For more\u003cbr/\u003einformation about using launch templates with Amazon EKS, see Launch template\u003cbr/\u003esupport (https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)\u003cbr/\u003ein the Amazon EKS User Guide. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nhealth: \n issues:\n - code: string\n message: string\n resourceIDs:\n - string\nmodifiedAt: string\nresources: \n autoScalingGroups:\n - name: string\n remoteAccessSecurityGroup: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix epoch timestamp at object creation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe health status of the node group. If there are issues with your node group\u0026rsquo;s\u003cbr/\u003ehealth, they are listed here.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing an issue with an Amazon EKS resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehealth.issues.[].resourceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe resources associated with the node group, such as Auto Scaling groups\u003cbr/\u003eand security groups for remote access.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.autoScalingGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.autoScalingGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Auto Scaling group that is associated with an Amazon EKS managed node\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003egroup.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresources.remoteAccessSecurityGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the managed node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:135,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/notebookinstance/",title:"NotebookInstance",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#NotebookInstance"\u003esagemaker-controller/apis/v1alpha1#NotebookInstance\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstances\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstance\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceleratorTypes:\n- string\nadditionalCodeRepositories:\n- string\ndefaultCodeRepository: string\ndirectInternetAccess: string\ninstanceType: string\nkmsKeyID: string\nlifecycleConfigName: string\nnotebookInstanceName: string\nplatformIdentifier: string\nroleARN: string\nrootAccess: string\nsecurityGroupIDs:\n- string\nsubnetID: string\ntags:\n- key: string\n value: string\nvolumeSizeInGB: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceleratorTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Elastic Inference (EI) instance types to associate with this notebook\u003cbr/\u003einstance. Currently, only one instance type can be associated with a notebook\u003cbr/\u003einstance. For more information, see Using Elastic Inference in Amazon SageMaker\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceleratorTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eadditionalCodeRepositories.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edirectInternetAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSets whether SageMaker provides internet access to the notebook instance.\u003cbr/\u003eIf you set this to Disabled this notebook instance is able to access resources\u003cbr/\u003eonly in your VPC, and is not be able to connect to SageMaker training and\u003cbr/\u003eendpoint services unless you configure a NAT Gateway in your VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Notebook Instances Are Internet-Enabled by Default\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/appendix-additional-considerations.html#appendix-notebook-and-internet-access).\u003cbr/\u003eYou can set the value of this parameter to Disabled only if you set a value\u003cbr/\u003efor the SubnetId parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of ML compute instance to launch for the notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service\u003cbr/\u003ekey that SageMaker uses to encrypt data on the storage volume attached to\u003cbr/\u003eyour notebook instance. The KMS key you provide must be enabled. For information,\u003cbr/\u003esee Enabling and Disabling Keys (https://docs.aws.amazon.com/kms/latest/developerguide/enabling-keys.html)\u003cbr/\u003ein the Amazon Web Services Key Management Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecycleConfigName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of a lifecycle configuration to associate with the notebook instance.\u003cbr/\u003eFor information about lifestyle configurations, see Step 2.1: (Optional)\u003cbr/\u003eCustomize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform identifier of the notebook instance runtime environment.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you send any requests to Amazon Web Services resources from the notebook\u003cbr/\u003einstance, SageMaker assumes this role to perform tasks on your behalf. You\u003cbr/\u003emust grant this role necessary permissions so SageMaker can perform these\u003cbr/\u003etasks. The policy must allow the SageMaker service principal (sagemaker.amazonaws.com)\u003cbr/\u003epermissions to assume this role. For more information, see SageMaker Roles\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erootAccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether root access is enabled or disabled for users of the notebook instance.\u003cbr/\u003eThe default value is Enabled.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLifecycle configurations need root access to be able to set up a notebook\u003cbr/\u003einstance. Because of this, lifecycle configurations associated with a notebook\u003cbr/\u003einstance always run with root access even if you disable root access for\u003cbr/\u003eusers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe VPC security group IDs, in the form sg-xxxxxxxx. The security groups\u003cbr/\u003emust be for the same VPC as specified in the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe size, in GB, of the ML storage volume to attach to the notebook instance.\u003cbr/\u003eThe default value is 5 GB. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nnotebookInstanceStatus: string\nstoppedByControllerMetadata: string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf status is Failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppedByControllerMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL that you use to connect to the Jupyter notebook that is running in\u003cbr/\u003eyour notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eurl\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL that you use to connect to the Jupyter notebook that is running in\u003cbr/\u003eyour notebook instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:136,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/",title:"NotebookInstanceLifecycleConfig",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#NotebookInstanceLifecycleConfig"\u003esagemaker-controller/apis/v1alpha1#NotebookInstanceLifecycleConfig\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceLifecycleConfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eNotebookInstanceLifecycleConfigList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstancelifecycleconfigs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003enotebookinstancelifecycleconfig\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003enotebookInstanceLifecycleConfigName: string\nonCreate:\n- content: string\nonStart:\n- content: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotebookInstanceLifecycleConfigName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the lifecycle configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonCreate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA shell script that runs only once, when you create a notebook instance.\u003cbr/\u003eThe shell script must be a base64-encoded string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eonCreate.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the notebook instance lifecycle configuration script.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eEach lifecycle configuration script has a limit of 16384 characters.\u003c/p\u003e\n\u003cp\u003eThe value of the $PATH environment variable that is available to both scripts\nis /sbin:bin:/usr/sbin:/usr/bin.\u003c/p\u003e\n\u003cp\u003eView Amazon CloudWatch Logs for notebook instance lifecycle configurations\nin log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].\u003c/p\u003e\n\u003cp\u003eLifecycle configuration scripts cannot run for longer than 5 minutes. If\na script runs for longer than 5 minutes, it fails and the notebook instance\nis not created or started.\u003c/p\u003e\n\u003cp\u003eFor information about notebook instance lifestyle configurations, see Step\n2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). || \u003cstrong\u003eonCreate.[].content\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eonStart\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA shell script that runs every time you start a notebook instance, including\u003cbr/\u003ewhen you create the notebook instance. The shell script must be a base64-encoded\u003cbr/\u003estring. |\n| \u003cstrong\u003eonStart.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the notebook instance lifecycle configuration script.\u003c/p\u003e\n\u003cp\u003eEach lifecycle configuration script has a limit of 16384 characters.\u003c/p\u003e\n\u003cp\u003eThe value of the $PATH environment variable that is available to both scripts\nis /sbin:bin:/usr/sbin:/usr/bin.\u003c/p\u003e\n\u003cp\u003eView Amazon CloudWatch Logs for notebook instance lifecycle configurations\nin log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].\u003c/p\u003e\n\u003cp\u003eLifecycle configuration scripts cannot run for longer than 5 minutes. If\na script runs for longer than 5 minutes, it fails and the notebook instance\nis not created or started.\u003c/p\u003e\n\u003cp\u003eFor information about notebook instance lifestyle configurations, see Step\n2.1: (Optional) Customize a Notebook Instance (https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html). || \u003cstrong\u003eonStart.[].content\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that tells when the lifecycle configuration was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that tells when the lifecycle configuration was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:137,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/openidconnectprovider/",title:"OpenIDConnectProvider",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#OpenIDConnectProvider"\u003eiam-controller/apis/v1alpha1#OpenIDConnectProvider\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOpenIDConnectProvider\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOpenIDConnectProviderList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eopenidconnectproviders\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eopenidconnectprovider\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientIDs:\n- string\ntags:\n- key: string\n value: string\nthumbprints:\n- string\nurl: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eProvides a list of client IDs, also known as audiences. When a mobile or\u003cbr/\u003eweb app registers with an OpenID Connect provider, they establish a value\u003cbr/\u003ethat identifies the application. This is the value that\u0026rsquo;s sent as the client_id\u003cbr/\u003eparameter on OAuth requests.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can register multiple client IDs with the same provider. For example,\u003cbr/\u003eyou might have multiple applications that use the same OIDC provider. You\u003cbr/\u003ecannot register more than 100 client IDs with a single IAM OIDC provider.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere is no defined format for a client ID. The CreateOpenIDConnectProviderRequest\u003cbr/\u003eoperation accepts client IDs up to 255 characters long.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ethumbprints\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of server certificate thumbprints for the OpenID Connect (OIDC) identity\u003cbr/\u003eprovider\u0026rsquo;s server certificates. Typically this list includes only one entry.\u003cbr/\u003eHowever, IAM lets you have up to five thumbprints for an OIDC provider. This\u003cbr/\u003elets you maintain multiple thumbprints if the identity provider is rotating\u003cbr/\u003ecertificates.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe server certificate thumbprint is the hex-encoded SHA-1 hash value of\u003cbr/\u003ethe X.509 certificate used by the domain where the OpenID Connect provider\u003cbr/\u003emakes its keys available. It is always a 40-character string.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide at least one thumbprint when creating an IAM OIDC provider.\u003cbr/\u003eFor example, assume that the OIDC provider is server.example.com and the\u003cbr/\u003eprovider stores its keys at https://keys.server.example.com/openid-connect.\u003cbr/\u003eIn that case, the thumbprint string would be the hex-encoded SHA-1 hash value\u003cbr/\u003eof the certificate used by https://keys.server.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about obtaining the OIDC provider thumbprint, see Obtaining\u003cbr/\u003ethe thumbprint for an OpenID Connect provider (https://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html)\u003cbr/\u003ein the IAM user Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ethumbprints.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:138,href:"https://aws-controllers-k8s.github.io/community/reference/organizations/v1alpha1/organizationalunit/",title:"OrganizationalUnit",description:null,content:'\u003cp\u003e\u003ccode\u003eorganizations.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/organizations-controller/apis/v1alpha1#OrganizationalUnit"\u003eorganizations-controller/apis/v1alpha1#OrganizationalUnit\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOrganizationalUnit\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOrganizationalUnitList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eorganizationalunits\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eorganizationalunit\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains details about an organizational unit (OU). An OU is a container\nof Amazon Web Services accounts within a root of an organization. Policies\nthat are attached to an OU apply to all accounts contained in that OU and\nin any child OUs.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nparentID: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe friendly name to assign to the new OU.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparentID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier (ID) of the parent root or OU that you want to create\u003cbr/\u003ethe new OU in.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) for a parent ID string\u003cbr/\u003erequires one of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Root - A string that begins with \u0026ldquo;r-\u0026rdquo; followed by from 4 to 32 lowercase\u003cbr/\u003e letters or digits.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Organizational unit (OU) - A string that begins with \u0026ldquo;ou-\u0026rdquo; followed\u003cbr/\u003e by from 4 to 32 lowercase letters or digits (the ID of the root that the\u003cbr/\u003e OU is in). This string is followed by a second \u0026ldquo;-\u0026rdquo; dash and from 8 to\u003cbr/\u003e 32 additional lowercase letters or digits.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the newly created OU. For each\u003cbr/\u003etag in the list, you must specify both a tag key and a value. You can set\u003cbr/\u003ethe value to an empty string, but you can\u0026rsquo;t set it to null. For more information\u003cbr/\u003eabout tagging, see Tagging Organizations resources (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html)\u003cbr/\u003ein the Organizations User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed number of\u003cbr/\u003etags for an OU, then the entire request fails and the OU is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource within your organization.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can attach tags to any of the following organization resources.\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eAmazon Web Services account\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eOrganizational unit (OU)\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eOrganization root\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003ePolicy || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier (ID) associated with this OU.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) for an organizational\u003cbr/\u003eunit ID string requires \u0026ldquo;ou-\u0026rdquo; followed by from 4 to 32 lowercase letters\u003cbr/\u003eor digits (the ID of the root that contains the OU). This string is followed\u003cbr/\u003eby a second \u0026ldquo;-\u0026rdquo; dash and from 8 to 32 additional lowercase letters or digits.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:139,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/originrequestpolicy/",title:"OriginRequestPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#OriginRequestPolicy"\u003ecloudfront-controller/apis/v1alpha1#OriginRequestPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOriginRequestPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eOriginRequestPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eoriginrequestpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eoriginrequestpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn origin request policy.\u003c/p\u003e\n\u003cp\u003eWhen it\u0026rsquo;s attached to a cache behavior, the origin request policy determines\nthe values that CloudFront includes in requests that it sends to the origin.\nEach request that CloudFront sends to the origin includes the following:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe request body and the URL path (without the domain name) from the\nviewer request.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe headers that CloudFront automatically includes in every origin request,\nincluding Host, User-Agent, and X-Amz-Cf-Id.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAll HTTP headers, cookies, and URL query strings that are specified\nin the cache policy or the origin request policy. These can include items\nfrom the viewer request and, in the case of headers, additional ones that\nare added by CloudFront.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eCloudFront sends a request when it can\u0026rsquo;t find an object in its cache that\nmatches the request. If you want to send values to the origin and also include\nthem in the cache key, use CachePolicy.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eoriginRequestPolicyConfig: \n comment: string\n cookiesConfig: \n cookieBehavior: string\n cookies: \n items:\n - string\n headersConfig: \n headerBehavior: string\n headers: \n items:\n - string\n name: string\n queryStringsConfig: \n queryStringBehavior: string\n queryStrings: \n items:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn origin request policy configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any cookies in viewer requests (and if\u003cbr/\u003eso, which cookies) are included in requests that CloudFront sends to the\u003cbr/\u003eorigin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookieBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of cookie names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.cookiesConfig.cookies.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headerBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of HTTP header names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.headersConfig.headers.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that determines whether any URL query strings in viewer requests\u003cbr/\u003e(and if so, which query strings) are included in requests that CloudFront\u003cbr/\u003esends to the origin.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStringBehavior\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a list of query string names.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoriginRequestPolicyConfig.queryStringsConfig.queryStrings.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\nlocation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier for the origin request policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the origin request policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:140,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/parametergroup/",title:"ParameterGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#ParameterGroup"\u003ememorydb-controller/apis/v1alpha1#ParameterGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eParameterGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eParameterGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eparametergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eparametergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of a CreateParameterGroup operation. A parameter group represents a combination of specific values for the parameters that are passed to the engine software during startup.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nfamily: string\nname: string\nparameterNameValues:\n- parameterName: string\n parameterValue: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional description of the parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group family that the parameter group can be used with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be updated per request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a name-value pair that is used to update the value of a parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameterNameValues.[].parameterValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nparameters:\n- allowedValues: string\n dataType: string\n description: string\n minimumEngineVersion: string\n name: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an individual setting that controls some aspect of MemoryDB behavior.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].dataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].minimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparameters.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:141,href:"https://aws-controllers-k8s.github.io/community/reference/pipes/v1alpha1/pipe/",title:"Pipe",description:null,content:'\u003cp\u003e\u003ccode\u003epipes.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/pipes-controller/apis/v1alpha1#Pipe"\u003epipes-controller/apis/v1alpha1#Pipe\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipe\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipeList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipes\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipe\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object that represents a pipe. Amazon EventBridgePipes connect event sources\nto targets and reduces the need for specialized knowledge and integration\ncode.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\ndesiredState: string\nenrichment: string\nenrichmentParameters: \n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n inputTemplate: string\nname: string\nroleARN: string\nsource: string\nsourceParameters: \n activeMQBrokerParameters: \n batchSize: integer\n credentials: \n basicAuth: string\n maximumBatchingWindowInSeconds: integer\n queueName: string\n dynamoDBStreamParameters: \n batchSize: integer\n deadLetterConfig: \n arn: string\n maximumBatchingWindowInSeconds: integer\n maximumRecordAgeInSeconds: integer\n maximumRetryAttempts: integer\n onPartialBatchItemFailure: string\n parallelizationFactor: integer\n startingPosition: string\n filterCriteria: \n filters:\n - pattern: string\n kinesisStreamParameters: \n batchSize: integer\n deadLetterConfig: \n arn: string\n maximumBatchingWindowInSeconds: integer\n maximumRecordAgeInSeconds: integer\n maximumRetryAttempts: integer\n onPartialBatchItemFailure: string\n parallelizationFactor: integer\n startingPosition: string\n startingPositionTimestamp: string\n managedStreamingKafkaParameters: \n batchSize: integer\n consumerGroupID: string\n credentials: \n clientCertificateTLSAuth: string\n saslSCRAM512Auth: string\n maximumBatchingWindowInSeconds: integer\n startingPosition: string\n topicName: string\n rabbitMQBrokerParameters: \n batchSize: integer\n credentials: \n basicAuth: string\n maximumBatchingWindowInSeconds: integer\n queueName: string\n virtualHost: string\n selfManagedKafkaParameters: \n additionalBootstrapServers:\n - string\n batchSize: integer\n consumerGroupID: string\n credentials: \n basicAuth: string\n clientCertificateTLSAuth: string\n saslSCRAM256Auth: string\n saslSCRAM512Auth: string\n maximumBatchingWindowInSeconds: integer\n serverRootCaCertificate: string\n startingPosition: string\n topicName: string\n vpc: \n securityGroup:\n - string\n subnets:\n - string\n sqsQueueParameters: \n batchSize: integer\n maximumBatchingWindowInSeconds: integer\ntags: {}\ntarget: string\ntargetParameters: \n batchJobParameters: \n arrayProperties: \n size: integer\n containerOverrides: \n command:\n - string\n environment:\n - name: string\n value: string\n instanceType: string\n resourceRequirements:\n - type_: string\n value: string\n dependsOn:\n - jobID: string\n type_: string\n jobDefinition: string\n jobName: string\n parameters: {}\n retryStrategy: \n attempts: integer\n cloudWatchLogsParameters: \n logStreamName: string\n timestamp: string\n ecsTaskParameters: \n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n enableECSManagedTags: boolean\n enableExecuteCommand: boolean\n group: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n overrides: \n containerOverrides:\n command:\n - string\n cpu: integer\n environment:\n - name: string\n value: string\n environmentFiles:\n - type_: string\n value: string\n memory: integer\n memoryReservation: integer\n name: string\n resourceRequirements:\n - type_: string\n value: string\n cpu: string\n ephemeralStorage: \n sizeInGiB: integer\n executionRoleARN: string\n inferenceAcceleratorOverrides:\n - deviceName: string\n deviceType: string\n memory: string\n taskRoleARN: string\n placementConstraints:\n - expression: string\n type_: string\n placementStrategy:\n - field: string\n type_: string\n platformVersion: string\n propagateTags: string\n referenceID: string\n tags:\n - key: string\n value: string\n taskCount: integer\n taskDefinitionARN: string\n eventBridgeEventBusParameters: \n detailType: string\n endpointID: string\n resources:\n - string\n source: string\n time: string\n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n inputTemplate: string\n kinesisStreamParameters: \n partitionKey: string\n lambdaFunctionParameters: \n invocationType: string\n redshiftDataParameters: \n database: string\n dbUser: string\n secretManagerARN: string\n sqls:\n - string\n statementName: string\n withEvent: boolean\n sageMakerPipelineParameters: \n pipelineParameterList:\n - name: string\n value: string\n sqsQueueParameters: \n messageDeduplicationID: string\n messageGroupID: string\n stepFunctionStateMachineParameters: \n invocationType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edesiredState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state the pipe should be in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the enrichment resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up enrichment on your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway REST\u003cbr/\u003eAPIs or EventBridge ApiDestinations. In the latter case, these are merged\u003cbr/\u003ewith any InvocationParameters specified on the Connection, with any values\u003cbr/\u003efrom the Connection taking precedence.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.headerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.pathParameterValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.httpParameters.pathParameterValues.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenrichmentParameters.inputTemplate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the role that allows the pipe to send data to the target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esource\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the source resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up a source for your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an Active MQ broker as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your broker credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.activeMQBrokerParameters.queueName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a DynamoDB stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.onPartialBatchItemFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.parallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.dynamoDBStreamParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe collection of event patterns used to filter events. For more information,\u003cbr/\u003esee Events and Event Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)\u003cbr/\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria.filters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.filterCriteria.filters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eFilter events using an event pattern. For more information, see Events and\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEvent Patterns (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a Kinesis stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumRecordAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.onPartialBatchItemFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.parallelizationFactor\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.kinesisStreamParameters.startingPositionTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an MSK stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your stream credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials.clientCertificateTLSAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.credentials.saslSCRAM512Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.managedStreamingKafkaParameters.topicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a Rabbit MQ broker as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your broker credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.queueName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.rabbitMQBrokerParameters.virtualHost\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using a self-managed Apache Kafka stream as a source.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.additionalBootstrapServers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.additionalBootstrapServers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.consumerGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Secrets Manager secret that stores your stream credentials.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.basicAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.clientCertificateTLSAuth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM256Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.credentials.saslSCRAM512Auth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.serverRootCaCertificate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e// Optional SecretManager ARN which stores the database credentials\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.startingPosition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.topicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the stream,\u003cbr/\u003eand whether a public IP address is to be used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.securityGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eList of SecurityGroupId.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.securityGroup.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.selfManagedKafkaParameters.vpc.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.sqsQueueParameters.batchSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceParameters.sqsQueueParameters.maximumBatchingWindowInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of key-value pairs to associate with the pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the target resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters required to set up a target for your pipe.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe parameters for using an Batch job as a target.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.arrayProperties\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe array properties for the submitted job, such as the size of the array.\u003cbr/\u003eThe array size can be between 2 and 10,000. If you specify array properties\u003cbr/\u003efor a job, it becomes an array job. This parameter is used only if the target\u003cbr/\u003eis an Batch job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.arrayProperties.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe overrides that are sent to a container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to send to the container. You can add new environment\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003evariables, which are added to the container at launch, or you can override\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe existing environment variables from the Docker image or the task definition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eEnvironment variables cannot start with \u0026ldquo;Batch\u0026rdquo;. This naming convention is\nreserved for variables that Batch sets. || \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.environment.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.resourceRequirements\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetParameters.batchJobParameters.containerOverrides.resourceRequirements.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresources include GPU, MEMORY, and VCPU. || **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.containerOverrides.resourceRequirements.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eAn object that represents an Batch job dependency. || **targetParameters.batchJobParameters.dependsOn.[].jobID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.dependsOn.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.jobDefinition**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.jobName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.parameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.batchJobParameters.retryStrategy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe retry strategy that\u0026rsquo;s associated with a job. For more information, see\u003cbr/\u003eAutomated job retries (https://docs.aws.amazon.com/batch/latest/userguide/job_retries.html)\u003cbr/\u003ein the Batch User Guide. |\n| **targetParameters.batchJobParameters.retryStrategy.attempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.cloudWatchLogsParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an CloudWatch Logs log stream as a target. |\n| **targetParameters.cloudWatchLogsParameters.logStreamName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.cloudWatchLogsParameters.timestamp**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an Amazon ECS task as a target. |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem\n(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html)\nin the Amazon ECS API Reference. || **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].base**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].capacityProvider**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.capacityProviderStrategy.[].weight**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.enableECSManagedTags**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.enableExecuteCommand**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.group**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.launchType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure specifies the network configuration for an Amazon ECS task. |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the task,\u003cbr/\u003eand whether a public IP address is to be used. This structure is relevant\u003cbr/\u003eonly for ECS tasks that use the awsvpc network mode. |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.networkConfiguration.awsVPCConfiguration.subnets.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.overrides**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe overrides that are associated with a task. |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe overrides that are sent to a container. An empty container override can\nbe passed in. An example of an empty container override is {\u0026ldquo;containerOverrides\u0026rdquo;:\n[ ] }. If a non-empty container override is specified, the name parameter\nmust be included. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].command.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].cpu**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe environment variables to send to the container. You can add new environment\nvariables, which are added to the container at launch, or you can override\nthe existing environment variables from the Docker image or the task definition.\nYou must also specify a container name. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environment.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA list of files containing the environment variables to pass to a container.\nYou can specify up to ten environment files. The file must have a .env file\nextension. Each line in an environment file should contain an environment\nvariable in VARIABLE=VALUE format. Lines beginning with # are treated as\ncomments and are ignored. For more information about the environment variable\nfile syntax, see Declare default environment variables in file (https://docs.docker.com/compose/env-file/).\u003c/p\u003e\n\u003cp\u003eIf there are environment variables specified using the environment parameter\nin a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that\ncontain the same variable, they\u0026rsquo;re processed from the top down. We recommend\nthat you use unique variable names. For more information, see Specifying\nenvironment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eThis parameter is only supported for tasks hosted on Fargate using the following\nplatform versions:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.4.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later. || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].environmentFiles.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memory**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].memoryReservation**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresource types are GPUs and Elastic Inference accelerators. For more information,\nsee Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html)\nor Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide || **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.containerOverrides.[].resourceRequirements.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.cpu**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.ephemeralStorage**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe amount of ephemeral storage to allocate for the task. This parameter\u003cbr/\u003eis used to expand the total amount of ephemeral storage available, beyond\u003cbr/\u003ethe default amount, for tasks hosted on Fargate. For more information, see\u003cbr/\u003eFargate task storage (https://docs.aws.amazon.com/AmazonECS/latest/userguide/using_data_volumes.html)\u003cbr/\u003ein the Amazon ECS User Guide for Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for tasks hosted on Fargate using Linux\u003cbr/\u003eplatform version 1.4.0 or later. This parameter is not supported for Windows\u003cbr/\u003econtainers on Fargate. |\n| **targetParameters.ecsTaskParameters.overrides.ephemeralStorage.sizeInGiB**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.executionRoleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDetails on an Elastic Inference accelerator task override. This parameter\nis used to override the Elastic Inference accelerator specified in the task\ndefinition. For more information, see Working with Amazon Elastic Inference\non Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide. || **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.inferenceAcceleratorOverrides.[].deviceType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.memory**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.overrides.taskRoleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eAn object representing a constraint on task placement. To learn more, see\nTask Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide. || **targetParameters.ecsTaskParameters.placementConstraints.[].expression**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementConstraints.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe task placement strategy for a task or service. To learn more, see Task\nPlacement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Service Developer Guide. || **targetParameters.ecsTaskParameters.placementStrategy.[].field**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.placementStrategy.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.platformVersion**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.propagateTags**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.referenceID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\nrules and event buses support tagging. || **targetParameters.ecsTaskParameters.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.taskCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targetParameters.ecsTaskParameters.taskDefinitionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using an EventBridge event bus as a target. |\n| **targetParameters.eventBridgeEventBusParameters.detailType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.endpointID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.resources**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.resources.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.eventBridgeEventBusParameters.source**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.eventBridgeEventBusParameters.time**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.httpParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway REST\u003cbr/\u003eAPIs or EventBridge ApiDestinations. |\n| **targetParameters.httpParameters.headerParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.httpParameters.pathParameterValues**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.httpParameters.pathParameterValues.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.httpParameters.queryStringParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targetParameters.inputTemplate**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.kinesisStreamParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Kinesis stream as a source. |\n| **targetParameters.kinesisStreamParameters.partitionKey**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.lambdaFunctionParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Lambda function as a target. |\n| **targetParameters.lambdaFunctionParameters.invocationType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.redshiftDataParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to be used when the target is a Amazon Redshift\u003cbr/\u003ecluster to invoke the Amazon Redshift Data API ExecuteStatement. |\n| **targetParameters.redshiftDataParameters.database**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// Redshift Database |\n| **targetParameters.redshiftDataParameters.dbUser**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// Database user name |\n| **targetParameters.redshiftDataParameters.secretManagerARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// For targets, can either specify an ARN or a jsonpath pointing to the ARN. |\n| **targetParameters.redshiftDataParameters.sqls**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e// A list of SQLs. |\n| **targetParameters.redshiftDataParameters.sqls.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targetParameters.redshiftDataParameters.statementName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e// A name for Redshift DataAPI statement which can be used as filter of //\u003cbr/\u003eListStatement. |\n| **targetParameters.redshiftDataParameters.withEvent**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a SageMaker pipeline as a target. |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eName/Value pair of a parameter to start execution of a SageMaker Model Building\nPipeline. || **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sageMakerPipelineParameters.pipelineParameterList.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sqsQueueParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Amazon SQS stream as a source. |\n| **targetParameters.sqsQueueParameters.messageDeduplicationID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.sqsQueueParameters.messageGroupID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targetParameters.stepFunctionStateMachineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe parameters for using a Step Functions state machine as a target. |\n| **targetParameters.stepFunctionStateMachineParameters.invocationType**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncurrentState: string\nlastModifiedTime: string\nstateReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time the pipe was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecurrentState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state the pipe is in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)\u003cbr/\u003e(YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason the pipe is in its current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:142,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/pipeline/",title:"Pipeline",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#Pipeline"\u003esagemaker-controller/apis/v1alpha1#Pipeline\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipeline\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelines\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipeline\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA SageMaker Model Building Pipeline instance.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eparallelismConfiguration: \n maxParallelExecutionSteps: integer\npipelineDefinition: string\npipelineDescription: string\npipelineDisplayName: string\npipelineName: string\nroleARN: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis is the configuration that controls the parallelism of the pipeline.\u003cbr/\u003eIf specified, it applies to all runs of this pipeline by default.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration.maxParallelExecutionSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON pipeline definition (https://aws-sagemaker-mlops.github.io/sagemaker-model-building-pipeline-definition-JSON-schema/)\u003cbr/\u003eof the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe display name of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the role used by the pipeline to access\u003cbr/\u003eand create resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to apply to the created pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\npipelineStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:143,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/pipelineexecution/",title:"PipelineExecution",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#PipelineExecution"\u003esagemaker-controller/apis/v1alpha1#PipelineExecution\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineExecution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePipelineExecutionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelineexecutions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epipelineexecution\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn execution of a pipeline.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eparallelismConfiguration: \n maxParallelExecutionSteps: integer\npipelineExecutionDescription: string\npipelineExecutionDisplayName: string\npipelineName: string\npipelineParameters:\n- name: string\n value: string\nselectiveExecutionConfig: \n selectedSteps:\n - stepName: string\n sourcePipelineExecutionARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis configuration, if specified, overrides the parallelism configuration\u003cbr/\u003eof the parent pipeline for this specific run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eparallelismConfiguration.maxParallelExecutionSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe display name of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or Amazon Resource Name (ARN) of the pipeline.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eContains a list of pipeline parameters. This list can be empty.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssigns a value to a named Pipeline parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineParameters.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe selective execution configuration applied to the pipeline run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.selectedSteps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.selectedSteps.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA step selected to run in selective execution mode.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eselectiveExecutionConfig.sourcePipelineExecutionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nfailureReason: string\nlastModifiedTime: string\npipelineExecutionStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline execution was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the execution failed, a message describing why.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time when the pipeline execution was modified last.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epipelineExecutionStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the pipeline execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:144,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/platformapplication/",title:"PlatformApplication",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#PlatformApplication"\u003esns-controller/apis/v1alpha1#PlatformApplication\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformApplication\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformApplicationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformapplications\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformapplication\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003ePlatform application object.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eeventDeliveryFailure: string\neventEndpointCreated: string\neventEndpointCreatedRef: \n from: \n name: string\neventEndpointDeleted: string\neventEndpointDeletedRef: \n from: \n name: string\neventEndpointUpdated: string\neventEndpointUpdatedRef: \n from: \n name: string\nfailureFeedbackRoleARN: string\nfailureFeedbackRoleRef: \n from: \n name: string\nname: string\nplatform: string\nplatformCredential: string\nplatformPrincipal: string\nsuccessFeedbackRoleARN: string\nsuccessFeedbackRoleRef: \n from: \n name: string\nsuccessFeedbackSampleRate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventDeliveryFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointCreatedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeleted\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointDeletedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventEndpointUpdatedRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureFeedbackRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eApplication names must be made up of only uppercase and lowercase ASCII letters,\u003cbr/\u003enumbers, underscores, hyphens, and periods, and must be between 1 and 256\u003cbr/\u003echaracters long.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatform\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe following platforms are supported: ADM (Amazon Device Messaging), APNS\u003cbr/\u003e(Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud\u003cbr/\u003eMessaging).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformCredential\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformPrincipal\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuccessFeedbackSampleRate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:145,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/platformendpoint/",title:"PlatformEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#PlatformEndpoint"\u003esns-controller/apis/v1alpha1#PlatformEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePlatformEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eplatformendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecustomUserData: string\nenabled: string\nplatformApplicationARN: string\ntoken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomUserData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eplatformApplicationARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ePlatformApplicationArn returned from CreatePlatformApplication is used to\u003cbr/\u003ecreate a an endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etoken\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nendpointARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpointARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEndpointArn returned from CreateEndpoint action.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:146,href:"https://aws-controllers-k8s.github.io/community/reference/eks/v1alpha1/podidentityassociation/",title:"PodIdentityAssociation",description:null,content:'\u003cp\u003e\u003ccode\u003eeks.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eks-controller/apis/v1alpha1#PodIdentityAssociation"\u003eeks-controller/apis/v1alpha1#PodIdentityAssociation\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePodIdentityAssociation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePodIdentityAssociationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epodidentityassociations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epodidentityassociation\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon EKS Pod Identity associations provide the ability to manage credentials\nfor your applications, similar to the way that Amazon EC2 instance profiles\nprovide credentials to Amazon EC2 instances.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclientRequestToken: string\nclusterName: string\nclusterRef: \n from: \n name: string\nnamespace: string\nroleARN: string\nroleRef: \n from: \n name: string\nserviceAccount: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientRequestToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency\u003cbr/\u003eof the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cluster to create the association in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Kubernetes namespace inside the cluster to create the association\u003cbr/\u003ein. The service account and the pods that use the service account must be\u003cbr/\u003ein this namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to associate with the service\u003cbr/\u003eaccount. The EKS Pod Identity agent manages credentials to assume this role\u003cbr/\u003efor applications in the containers in the pods that use this service account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceAccount\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Kubernetes service account inside the cluster to associate\u003cbr/\u003ethe IAM credentials with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eMetadata that assists with categorization and organization. Each tag consists\u003cbr/\u003eof a key and an optional value. You define both. Tags don\u0026rsquo;t propagate to\u003cbr/\u003eany other cluster or Amazon Web Services resources.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource – 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length – 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length – 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociationARN: string\nassociationID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nmodifiedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociationARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the association.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the association.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe timestamp that the association was created at.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodifiedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe most recent timestamp that the association was modified at\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:147,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/policy/",title:"Policy",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Policy"\u003eiam-controller/apis/v1alpha1#Policy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a managed policy.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the CreatePolicy, GetPolicy,\nand ListPolicies operations.\u003c/p\u003e\n\u003cp\u003eFor more information about managed policies, refer to Managed policies and\ninline policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)\nin the IAM User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\npath: string\npolicyDocument: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly description of the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTypically used to store information about the permissions defined in the\u003cbr/\u003epolicy. For example, \u0026ldquo;Grants access to production DynamoDB tables.\u0026quot;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe policy description is immutable. After a value is assigned, it cannot\u003cbr/\u003ebe changed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe friendly name of the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path for the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about paths, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou cannot use an asterisk (*) in the path name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyDocument\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON policy document that you want to use as the content for the new\u003cbr/\u003epolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide policies in JSON format in IAM. However, for CloudFormation\u003cbr/\u003etemplates formatted in YAML, you can provide the policy in JSON or YAML format.\u003cbr/\u003eCloudFormation always converts a YAML policy to JSON format before submitting\u003cbr/\u003eit to IAM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe maximum length of the policy document that you can pass in this operation,\u003cbr/\u003eincluding whitespace, is listed below. To view the maximum character counts\u003cbr/\u003eof a managed policy with no whitespaces, see IAM and STS character quotas\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html#reference_iam-quotas-entity-length).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo learn more about JSON policy grammar, see Grammar of the IAM JSON policy\u003cbr/\u003elanguage (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_grammar.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) used to validate this\u003cbr/\u003eparameter is a string of characters consisting of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Any printable ASCII character ranging from the space character (\\u0020)\u003cbr/\u003e through the end of the ASCII character range\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The special characters tab (\\u0009), line feed (\\u000A), and carriage\u003cbr/\u003e return (\\u000D)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new IAM customer managed policy.\u003cbr/\u003eEach tag consists of a key name and an associated value. For more information\u003cbr/\u003eabout tagging, see Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ewith an IAM resource. For more information about tagging, see Tagging IAM\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the IAM User Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nattachmentCount: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\ndefaultVersionID: string\nisAttachable: boolean\npermissionsBoundaryUsageCount: integer\npolicyID: string\nupdateDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattachmentCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of entities (users, groups, and roles) that the policy is attached\u003cbr/\u003eto.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultVersionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the version of the policy that is set as the default version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisAttachable\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the policy can be attached to an IAM user, group, or role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryUsageCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of entities (users and roles) for which the policy is used to\u003cbr/\u003eset the permissions boundary.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about permissions boundaries, see Permissions boundaries\u003cbr/\u003efor IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the policy was last updated.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen a policy has only one version, this field contains the date and time\u003cbr/\u003ewhen the policy was created. When a policy has more than one version, this\u003cbr/\u003efield contains the date and time when the most recent policy version was\u003cbr/\u003ecreated.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:148,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/processingjob/",title:"ProcessingJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#ProcessingJob"\u003esagemaker-controller/apis/v1alpha1#ProcessingJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eProcessingJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eProcessingJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eprocessingjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eprocessingjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn Amazon SageMaker processing job that is used to analyze data and evaluate\nmodels. For more information, see Process Data and Evaluate Models (https://docs.aws.amazon.com/sagemaker/latest/dg/processing-job.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eappSpecification: \n containerArguments:\n - string\n containerEntrypoint:\n - string\n imageURI: string\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nnetworkConfig: \n enableInterContainerTrafficEncryption: boolean\n enableNetworkIsolation: boolean\n vpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\nprocessingInputs:\n- appManaged: boolean\n datasetDefinition: \n athenaDatasetDefinition: \n catalog: string\n database: string\n kmsKeyID: string\n outputCompression: string\n outputFormat: string\n outputS3URI: string\n queryString: string\n workGroup: string\n dataDistributionType: string\n inputMode: string\n localPath: string\n redshiftDatasetDefinition: \n clusterID: string\n clusterRoleARN: string\n database: string\n dbUser: string\n kmsKeyID: string\n outputCompression: string\n outputFormat: string\n outputS3URI: string\n queryString: string\n inputName: string\n s3Input: \n localPath: string\n s3CompressionType: string\n s3DataDistributionType: string\n s3DataType: string\n s3InputMode: string\n s3URI: string\nprocessingJobName: string\nprocessingOutputConfig: \n kmsKeyID: string\n outputs:\n - appManaged: boolean\n featureStoreOutput: \n featureGroupName: string\n outputName: string\n s3Output: \n localPath: string\n s3URI: string\n s3UploadMode: string\nprocessingResources: \n clusterConfig: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nroleARN: string\nstoppingCondition: \n maxRuntimeInSeconds: integer\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the processing job to run a specified Docker container image.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerArguments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerArguments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eappSpecification.containerEntrypoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container. Up to 100 key and\u003cbr/\u003evalues entries in the map are supported.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNetworking options for a processing job, such as whether to allow inbound\u003cbr/\u003eand outbound network calls to and from processing containers, and the VPC\u003cbr/\u003esubnets and security groups to use for VPC-enabled processing jobs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.enableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs,\u003cbr/\u003ehosted models, and compute resources have access to. You can control access\u003cbr/\u003eto and from your resources by configuring a VPC. For more information, see\u003cbr/\u003eGive SageMaker Access to Resources in your Amazon VPC (https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkConfig.vpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inputs for a processing job. The processing input must specify exactly\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eone of either S3Input or DatasetDefinition types.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Dataset Definition inputs. The Dataset Definition input\u003cbr/\u003emust specify exactly one of either AthenaDatasetDefinition or RedshiftDatasetDefinition\u003cbr/\u003etypes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Athena Dataset Definition input.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.catalog\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the data catalog used in Athena query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the database used in the Athena query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputCompression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compression used for Athena query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe data storage format for Athena query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.outputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.queryString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SQL query statements, to be executed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.athenaDatasetDefinition.workGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the workgroup in which the Athena query is being started.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.dataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.inputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for Redshift Dataset Definition input.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.clusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Redshift cluster Identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.clusterRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.database\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Redshift database used in Redshift query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.dbUser\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe database user name used in Redshift query execution.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputCompression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compression used for Redshift query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe data storage format for Redshift query results.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.outputS3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].datasetDefinition.redshiftDatasetDefinition.queryString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe SQL query statements to be executed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].inputName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for downloading input data from Amazon S3 into the processing\u003cbr/\u003econtainer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3CompressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3DataDistributionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3InputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingInputs.[].s3Input.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingJobName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the processing job. The name must be unique within an Amazon\u003cbr/\u003eWeb Services Region in the Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOutput configuration for the processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of a processing job. The processing output must specify\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eexactly one of either S3Output or FeatureStoreOutput types.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].featureStoreOutput\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for processing job outputs in Amazon SageMaker Feature Store.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].featureStoreOutput.featureGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].outputName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for uploading output data to Amazon S3 from the processing\u003cbr/\u003econtainer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingOutputConfig.outputs.[].s3Output.s3UploadMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIdentifies the resources, ML compute instances, and ML storage volumes to\u003cbr/\u003edeploy for a processing job. In distributed training, you specify more than\u003cbr/\u003eone instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for the cluster used to run a processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingResources.clusterConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume\u003cbr/\u003eto perform tasks on your behalf.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe time limit for how long the processing job is allowed to run.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-whatURL)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\nprocessingJobStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string, up to one KB in size, that contains the reason a processing job\u003cbr/\u003efailed, if it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprocessingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides the status of a processing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:149,href:"https://aws-controllers-k8s.github.io/community/reference/ecr/v1alpha1/pullthroughcacherule/",title:"PullThroughCacheRule",description:null,content:'\u003cp\u003e\u003ccode\u003eecr.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecr-controller/apis/v1alpha1#PullThroughCacheRule"\u003eecr-controller/apis/v1alpha1#PullThroughCacheRule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePullThroughCacheRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ePullThroughCacheRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epullthroughcacherules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003epullthroughcacherule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details of a pull through cache rule.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eecrRepositoryPrefix: string\nregistryID: string\nupstreamRegistryURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eecrRepositoryPrefix\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe repository name prefix to use when caching images from the source registry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregistryID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID associated with the registry to create\u003cbr/\u003ethe pull through cache rule for. If you do not specify a registry, the default\u003cbr/\u003eregistry is assumed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupstreamRegistryURL\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe registry URL of the upstream public registry to use as the source for\u003cbr/\u003ethe pull through cache rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in JavaScript date format, when the pull through cache\u003cbr/\u003erule was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:150,href:"https://aws-controllers-k8s.github.io/community/reference/sqs/v1alpha1/queue/",title:"Queue",description:null,content:'\u003cp\u003e\u003ccode\u003esqs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sqs-controller/apis/v1alpha1#Queue"\u003esqs-controller/apis/v1alpha1#Queue\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eQueue\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eQueueList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003equeues\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003equeue\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtentBasedDeduplication: string\ndelaySeconds: string\nfifoQueue: string\nkmsDataKeyReusePeriodSeconds: string\nkmsMasterKeyID: string\nkmsMasterKeyRef: \n from: \n name: string\nmaximumMessageSize: string\nmessageRetentionPeriod: string\npolicy: string\npolicyRef: \n from: \n name: string\nqueueName: string\nreceiveMessageWaitTimeSeconds: string\nredriveAllowPolicy: string\nredrivePolicy: string\ntags: {}\nvisibilityTimeout: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentBasedDeduplication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edelaySeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efifoQueue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsDataKeyReusePeriodSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaximumMessageSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emessageRetentionPeriod\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereceiveMessageWaitTimeSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredriveAllowPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredrivePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdd cost allocation tags to the specified Amazon SQS queue. For an overview,\u003cbr/\u003esee Tagging Your Amazon SQS Queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you use queue tags, keep the following guidelines in mind:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Adding more than 50 tags to a queue isn\u0026rsquo;t recommended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tags don\u0026rsquo;t have any semantic meaning. Amazon SQS interprets tags as\u003cbr/\u003e character strings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tags are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A new tag with a key identical to that of an existing tag overwrites\u003cbr/\u003e the existing tag.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a full list of tag restrictions, see Quotas related to queues (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to tag a queue on creation, you must have the sqs:CreateQueue\u003cbr/\u003eand sqs:TagQueue permissions.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCross-account permissions don\u0026rsquo;t apply to this action. For more information,\u003cbr/\u003esee Grant cross-account permissions to a role and a username (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name)\u003cbr/\u003ein the Amazon SQS Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evisibilityTimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nqueueARN: string\nqueueURL: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equeueURL\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URL of the created Amazon SQS queue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:151,href:"https://aws-controllers-k8s.github.io/community/reference/route53/v1alpha1/recordset/",title:"RecordSet",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53-controller/apis/v1alpha1#RecordSet"\u003eroute53-controller/apis/v1alpha1#RecordSet\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRecordSet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRecordSetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erecordsets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erecordset\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealiasTarget: \n dnsName: string\n evaluateTargetHealth: boolean\n hostedZoneID: string\nchangeBatch: \n changes:\n - action: string\n resourceRecordSet: \n aliasTarget: \n dnsName: string\n evaluateTargetHealth: boolean\n hostedZoneID: string\n cidrRoutingConfig: \n collectionID: string\n locationName: string\n failover: string\n geoLocation: \n continentCode: string\n countryCode: string\n subdivisionCode: string\n healthCheckID: string\n multiValueAnswer: boolean\n name: string\n region: string\n resourceRecords:\n - value: string\n setIdentifier: string\n trafficPolicyInstanceID: string\n ttl: integer\n type_: string\n weight: integer\n comment: string\ncidrRoutingConfig: \n collectionID: string\n locationName: string\nfailover: string\ngeoLocation: \n continentCode: string\n countryCode: string\n subdivisionCode: string\nhealthCheckID: string\nhostedZoneID: string\nhostedZoneRef: \n from: \n name: string\nmultiValueAnswer: boolean\nname: string\nrecordType: string\nregion: string\nresourceRecords:\n- value: string\nsetIdentifier: string\nttl: integer\nweight: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlias resource record sets only: Information about the Amazon Web Services\u003cbr/\u003eresource, such as a CloudFront distribution or an Amazon S3 bucket, that\u003cbr/\u003eyou want to route traffic to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating resource records sets for a private hosted zone, note\u003cbr/\u003ethe following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create an alias resource record set in a private hosted zone\u003cbr/\u003e to route traffic to a CloudFront distribution.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For information about creating failover resource record sets in a private\u003cbr/\u003e hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\u003cbr/\u003e in the Amazon Route 53 Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.evaluateTargetHealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealiasTarget.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains an optional comment and the Changes element.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information for each resource record set that you want to change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the resource record set to create or delete.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlias resource record sets only: Information about the Amazon Web Services\u003cbr/\u003eresource, such as a CloudFront distribution or an Amazon S3 bucket, that\u003cbr/\u003eyou want to route traffic to.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen creating resource record sets for a private hosted zone, note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For information about creating failover resource record sets in a private\u003cbr/\u003e hosted zone, see Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.dnsName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.evaluateTargetHealth\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.aliasTarget.hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe object that is specified in resource record set object when you are linking\u003cbr/\u003ea resource record set to a CIDR location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA LocationName with an asterisk “*” can be used to create a default CIDR\u003cbr/\u003erecord. CollectionId is still required for default record.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig.collectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.cidrRoutingConfig.locationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.failover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains information about a geographic location.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.continentCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.countryCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.geoLocation.subdivisionCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.healthCheckID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.multiValueAnswer\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation specific to the resource record.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecord. || \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.resourceRecords.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.setIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.trafficPolicyInstanceID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003echangeBatch.changes.[].resourceRecordSet.ttl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| **changeBatch.changes.[].resourceRecordSet.type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **changeBatch.changes.[].resourceRecordSet.weight**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **changeBatch.comment**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **cidrRoutingConfig**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThe object that is specified in resource record set object when you are linking\u003cbr/\u003ea resource record set to a CIDR location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA LocationName with an asterisk “*” can be used to create a default CIDR\u003cbr/\u003erecord. CollectionId is still required for default record. |\n| **cidrRoutingConfig.collectionID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **cidrRoutingConfig.locationName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **failover**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eFailover resource record sets only: To configure failover, you add the Failover\u003cbr/\u003eelement to two resource record sets. For one resource record set, you specify\u003cbr/\u003ePRIMARY as the value for Failover; for the other resource record set, you\u003cbr/\u003especify SECONDARY. In addition, you include the HealthCheckId element and\u003cbr/\u003especify the health check that you want Amazon Route 53 to perform for each\u003cbr/\u003eresource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExcept where noted, the following failover behaviors assume that you have\u003cbr/\u003eincluded the HealthCheckId element in both resource record sets:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the primary resource record set is healthy, Route 53 responds to\u003cbr/\u003e DNS queries with the applicable value from the primary resource record\u003cbr/\u003e set regardless of the health of the secondary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the primary resource record set is unhealthy and the secondary\u003cbr/\u003e resource record set is healthy, Route 53 responds to DNS queries with\u003cbr/\u003e the applicable value from the secondary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the secondary resource record set is unhealthy, Route 53 responds\u003cbr/\u003e to DNS queries with the applicable value from the primary resource record\u003cbr/\u003e set regardless of the health of the primary resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you omit the HealthCheckId element for the secondary resource record\u003cbr/\u003e set, and if the primary resource record set is unhealthy, Route 53 always\u003cbr/\u003e responds to DNS queries with the applicable value from the secondary resource\u003cbr/\u003e record set. This is true regardless of the health of the associated endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create non-failover resource record sets that have the same values\u003cbr/\u003efor the Name and Type elements as failover resource record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor failover alias resource record sets, you must also include the EvaluateTargetHealth\u003cbr/\u003eelement and set the value to true.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about configuring failover for Route 53, see the following\u003cbr/\u003etopics in the Amazon Route 53 Developer Guide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html) |\n| **geoLocation**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eGeolocation resource record sets only: A complex type that lets you control\u003cbr/\u003ehow Amazon Route 53 responds to DNS queries based on the geographic origin\u003cbr/\u003eof the query. For example, if you want all queries from Africa to be routed\u003cbr/\u003eto a web server with an IP address of 192.0.2.111, create a resource record\u003cbr/\u003eset with a Type of A and a ContinentCode of AF.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlthough creating geolocation and geolocation alias resource record sets\u003cbr/\u003ein a private hosted zone is allowed, it\u0026rsquo;s not supported.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create separate resource record sets for overlapping geographic regions\u003cbr/\u003e(for example, one resource record set for a continent and one for a country\u003cbr/\u003eon the same continent), priority goes to the smallest geographic region.\u003cbr/\u003eThis allows you to route most queries for a continent to one resource and\u003cbr/\u003eto route queries for a country on that continent to a different resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create two geolocation resource record sets that specify the same\u003cbr/\u003egeographic location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value * in the CountryCode element matches all geographic locations that\u003cbr/\u003earen\u0026rsquo;t specified in other geolocation resource record sets that have the\u003cbr/\u003esame values for the Name and Type elements.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eGeolocation works by mapping IP addresses to locations. However, some IP\u003cbr/\u003eaddresses aren\u0026rsquo;t mapped to geographic locations, so even if you create geolocation\u003cbr/\u003eresource record sets that cover all seven continents, Route 53 will receive\u003cbr/\u003esome DNS queries from locations that it can\u0026rsquo;t identify. We recommend that\u003cbr/\u003eyou create a resource record set for which the value of CountryCode is *.\u003cbr/\u003eTwo groups of queries are routed to the resource that you specify in this\u003cbr/\u003erecord: queries that come from locations for which you haven\u0026rsquo;t created geolocation\u003cbr/\u003eresource record sets and queries from IP addresses that aren\u0026rsquo;t mapped to\u003cbr/\u003ea location. If you don\u0026rsquo;t create a * resource record set, Route 53 returns\u003cbr/\u003ea \u0026ldquo;no answer\u0026rdquo; response for queries from those locations.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create non-geolocation resource record sets that have the same\u003cbr/\u003evalues for the Name and Type elements as geolocation resource record sets. |\n| **geoLocation.continentCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **geoLocation.countryCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **geoLocation.subdivisionCode**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **healthCheckID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eIf you want Amazon Route 53 to return this resource record set in response\u003cbr/\u003eto a DNS query only when the status of a health check is healthy, include\u003cbr/\u003ethe HealthCheckId element and specify the ID of the applicable health check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRoute 53 determines whether a resource record set is healthy based on one\u003cbr/\u003eof the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By periodically sending a request to the endpoint that is specified\u003cbr/\u003e in the health check\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By aggregating the status of a specified group of health checks (calculated\u003cbr/\u003e health checks)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * By determining the current state of a CloudWatch alarm (CloudWatch metric\u003cbr/\u003e health checks)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eRoute 53 doesn\u0026rsquo;t check the health of the endpoint that is specified in the\u003cbr/\u003eresource record set, for example, the endpoint specified by the IP address\u003cbr/\u003ein the Value element. When you add a HealthCheckId element to a resource\u003cbr/\u003erecord set, Route 53 checks the health of the endpoint that you specified\u003cbr/\u003ein the health check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see the following topics in the Amazon Route 53 Developer\u003cbr/\u003eGuide:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * How Amazon Route 53 Determines Whether an Endpoint Is Healthy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 Health Checks and DNS Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Configuring Failover in a Private Hosted Zone (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen to Specify HealthCheckId\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecifying a value for HealthCheckId is useful only when Route 53 is choosing\u003cbr/\u003ebetween two or more resource record sets to respond to a DNS query, and you\u003cbr/\u003ewant Route 53 to base the choice in part on the status of a health check.\u003cbr/\u003eConfiguring health checks makes sense only in the following configurations:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Non-alias resource record sets: You\u0026rsquo;re checking the health of a group\u003cbr/\u003e of non-alias resource record sets that have the same routing policy, name,\u003cbr/\u003e and type (such as multiple weighted records named www.example.com with\u003cbr/\u003e a type of A) and you specify health check IDs for all the resource record\u003cbr/\u003e sets. If the health check status for a resource record set is healthy,\u003cbr/\u003e Route 53 includes the record among the records that it responds to DNS\u003cbr/\u003e queries with. If the health check status for a resource record set is\u003cbr/\u003e unhealthy, Route 53 stops responding to DNS queries using the value for\u003cbr/\u003e that resource record set. If the health check status for all resource\u003cbr/\u003e record sets in the group is unhealthy, Route 53 considers all resource\u003cbr/\u003e record sets in the group healthy and responds to DNS queries accordingly.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Alias resource record sets: You specify the following settings: You\u003cbr/\u003e set EvaluateTargetHealth to true for an alias resource record set in a\u003cbr/\u003e group of resource record sets that have the same routing policy, name,\u003cbr/\u003e and type (such as multiple weighted records named www.example.com with\u003cbr/\u003e a type of A). You configure the alias resource record set to route traffic\u003cbr/\u003e to a non-alias resource record set in the same hosted zone. You specify\u003cbr/\u003e a health check ID for the non-alias resource record set. If the health\u003cbr/\u003e check status is healthy, Route 53 considers the alias resource record\u003cbr/\u003e set to be healthy and includes the alias record among the records that\u003cbr/\u003e it responds to DNS queries with. If the health check status is unhealthy,\u003cbr/\u003e Route 53 stops responding to DNS queries using the alias resource record\u003cbr/\u003e set. The alias resource record set can also route traffic to a group of\u003cbr/\u003e non-alias resource record sets that have the same routing policy, name,\u003cbr/\u003e and type. In that configuration, associate health checks with all of the\u003cbr/\u003e resource record sets in the group of non-alias resource record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eGeolocation Routing\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor geolocation resource record sets, if an endpoint is unhealthy, Route\u003cbr/\u003e53 looks for a resource record set for the larger, associated geographic\u003cbr/\u003eregion. For example, suppose you have resource record sets for a state in\u003cbr/\u003ethe United States, for the entire United States, for North America, and a\u003cbr/\u003eresource record set that has * for CountryCode is *, which applies to all\u003cbr/\u003elocations. If the endpoint for the state resource record set is unhealthy,\u003cbr/\u003eRoute 53 checks for healthy resource record sets in the following order until\u003cbr/\u003eit finds a resource record set for which the endpoint is healthy:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The United States\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * North America\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The default resource record set\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSpecifying the Health Check Endpoint by Domain Name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your health checks specify the endpoint only by domain name, we recommend\u003cbr/\u003ethat you create a separate health check for each endpoint. For example, create\u003cbr/\u003ea health check for each HTTP server that is serving content for www.example.com.\u003cbr/\u003eFor the value of FullyQualifiedDomainName, specify the domain name of the\u003cbr/\u003eserver (such as us-east-2-www.example.com), not the name of the resource\u003cbr/\u003erecord sets (www.example.com).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eHealth check results will be unpredictable if you do the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Create a health check that has the same value for FullyQualifiedDomainName\u003cbr/\u003e as the name of a resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Associate that health check with the resource record set. |\n| **hostedZoneID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eThe ID of the hosted zone that contains the resource record sets that you\u003cbr/\u003ewant to change. |\n| **hostedZoneRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **hostedZoneRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **hostedZoneRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **multiValueAnswer**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003eMultivalue answer resource record sets only: To route traffic approximately\u003cbr/\u003erandomly to multiple resources, such as web servers, create one multivalue\u003cbr/\u003eanswer record for each resource and specify true for MultiValueAnswer. Note\u003cbr/\u003ethe following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you associate a health check with a multivalue answer resource record\u003cbr/\u003e set, Amazon Route 53 responds to DNS queries with the corresponding IP\u003cbr/\u003e address only when the health check is healthy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you don\u0026rsquo;t associate a health check with a multivalue answer record,\u003cbr/\u003e Route 53 always considers the record to be healthy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Route 53 responds to DNS queries with up to eight healthy records; if\u003cbr/\u003e you have eight or fewer healthy records, Route 53 responds to all DNS\u003cbr/\u003e queries with all the healthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you have more than eight healthy records, Route 53 responds to different\u003cbr/\u003e DNS resolvers with different combinations of healthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When all records are unhealthy, Route 53 responds to DNS queries with\u003cbr/\u003e up to eight unhealthy records.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If a resource becomes unavailable after a resolver caches a response,\u003cbr/\u003e client software typically tries another of the IP addresses in the response.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t create multivalue answer alias records. |\n| **name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eFor ChangeResourceRecordSets requests, the name of the record that you want\u003cbr/\u003eto create, update, or delete. For ListResourceRecordSets responses, the name\u003cbr/\u003eof a record in the specified hosted zone.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eChangeResourceRecordSets Only\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEnter a fully qualified domain name, for example, www.example.com. You can\u003cbr/\u003eoptionally include a trailing dot. If you omit the trailing dot, Amazon Route\u003cbr/\u003e53 assumes that the domain name that you specify is fully qualified. This\u003cbr/\u003emeans that Route 53 treats www.example.com (without a trailing dot) and www.example.com.\u003cbr/\u003e(with a trailing dot) as identical.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about how to specify characters other than a-z, 0-9, and\u003cbr/\u003e- (hyphen) and how to specify internationalized domain names, see DNS Domain\u003cbr/\u003eName Format (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the asterisk (*) wildcard to replace the leftmost label in a\u003cbr/\u003edomain name, for example, *.example.com. Note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The * must replace the entire label. For example, you can\u0026rsquo;t specify\u003cbr/\u003e *prod.example.com or prod*.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The * can\u0026rsquo;t replace any of the middle labels, for example, marketing.*.example.com.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you include * in any position other than the leftmost label in a\u003cbr/\u003e domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\u003cbr/\u003e You can\u0026rsquo;t use the * wildcard for resource records sets that have a type\u003cbr/\u003e of NS.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the * wildcard as the leftmost label in a domain name, for example,\u003cbr/\u003e*.example.com. You can\u0026rsquo;t use an * for one of the middle labels, for example,\u003cbr/\u003emarketing.*.example.com. In addition, the * must replace the entire label;\u003cbr/\u003efor example, you can\u0026rsquo;t specify prod*.example.com. |\n| **recordType**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eThe DNS record type. For information about different record types and how\u003cbr/\u003edata is encoded for them, see Supported DNS Resource Record Types (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for basic resource record sets: A | AAAA | CAA | CNAME | DS\u003cbr/\u003e|MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValues for weighted, latency, geolocation, and failover resource record sets:\u003cbr/\u003eA | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating\u003cbr/\u003ea group of weighted, latency, geolocation, or failover resource record sets,\u003cbr/\u003especify the same value for all of the resource record sets in the group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for multivalue answer resource record sets: A | AAAA | MX |\u003cbr/\u003eNAPTR | PTR | SPF | SRV | TXT\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSPF records were formerly used to verify the identity of the sender of email\u003cbr/\u003emessages. However, we no longer recommend that you create resource record\u003cbr/\u003esets for which the value of Type is SPF. RFC 7208, Sender Policy Framework\u003cbr/\u003e(SPF) for Authorizing Use of Domains in Email, Version 1, has been updated\u003cbr/\u003eto say, \u0026ldquo;\u0026hellip;[I]ts existence and mechanism defined in [RFC4408] have led to\u003cbr/\u003esome interoperability issues. Accordingly, its use is no longer appropriate\u003cbr/\u003efor SPF version 1; implementations are not to use it.\u0026rdquo; In RFC 7208, see section\u003cbr/\u003e14.1, The SPF DNS Record Type (http://tools.ietf.org/html/rfc7208#section-14.1).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValues for alias resource record sets:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon API Gateway custom regional APIs and edge-optimized APIs: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CloudFront distributions: A If IPv6 is enabled for the distribution,\u003cbr/\u003e create two resource record sets to route traffic to your distribution,\u003cbr/\u003e one with a value of A and one with a value of AAAA.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon API Gateway environment that has a regionalized subdomain: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ELB load balancers: A | AAAA\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon S3 buckets: A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Virtual Private Cloud interface VPC endpoints A\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Another resource record set in this hosted zone: Specify the type of\u003cbr/\u003e the resource record set that you\u0026rsquo;re creating the alias for. All values\u003cbr/\u003e are supported except NS and SOA. If you\u0026rsquo;re creating an alias record that\u003cbr/\u003e has the same name as the hosted zone (known as the zone apex), you can\u0026rsquo;t\u003cbr/\u003e route traffic to a record for which the value of Type is CNAME. This is\u003cbr/\u003e because the alias record must have the same type as the record you\u0026rsquo;re\u003cbr/\u003e routing traffic to, and creating a CNAME record for the zone apex isn\u0026rsquo;t\u003cbr/\u003e supported even for an alias record. |\n| **region**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eLatency-based resource record sets only: The Amazon EC2 Region where you\u003cbr/\u003ecreated the resource that this resource record set refers to. The resource\u003cbr/\u003etypically is an Amazon Web Services resource, such as an EC2 instance or\u003cbr/\u003ean ELB load balancer, and is referred to by an IP address or a DNS domain\u003cbr/\u003ename, depending on the record type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen Amazon Route 53 receives a DNS query for a domain name and type for\u003cbr/\u003ewhich you have created latency resource record sets, Route 53 selects the\u003cbr/\u003elatency resource record set that has the lowest latency between the end user\u003cbr/\u003eand the associated Amazon EC2 Region. Route 53 then returns the value that\u003cbr/\u003eis associated with the selected resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only specify one ResourceRecord per latency resource record\u003cbr/\u003e set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only create one latency resource record set for each Amazon\u003cbr/\u003e EC2 Region.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You aren\u0026rsquo;t required to create latency resource record sets for all Amazon\u003cbr/\u003e EC2 Regions. Route 53 will choose the region with the best latency from\u003cbr/\u003e among the regions that you create latency resource record sets for.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create non-latency resource record sets that have the same\u003cbr/\u003e values for the Name and Type elements as latency resource record sets. |\n| **resourceRecords**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eInformation about the resource records to act upon.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecords. |\n| **resourceRecords.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation specific to the resource record.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re creating an alias resource record set, omit ResourceRecord. || \u003cstrong\u003eresourceRecords.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esetIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eResource record sets that have a routing policy other than simple: An identifier\u003cbr/\u003ethat differentiates among multiple resource record sets that have the same\u003cbr/\u003ecombination of name and type, such as multiple weighted resource record sets\u003cbr/\u003enamed acme.example.com that have a type of A. In a group of resource record\u003cbr/\u003esets that have the same name and type, the value of SetIdentifier must be\u003cbr/\u003eunique for each resource record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about routing policies, see Choosing a Routing Policy (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html)\u003cbr/\u003ein the Amazon Route 53 Developer Guide. |\n| \u003cstrong\u003ettl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe resource record cache time to live (TTL), in seconds. Note the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you\u0026rsquo;re creating or updating an alias resource record set, omit TTL.\u003cbr/\u003e Amazon Route 53 uses the value of TTL for the alias target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If you\u0026rsquo;re associating this resource record set with a health check (if\u003cbr/\u003e you\u0026rsquo;re adding a HealthCheckId element), we recommend that you specify\u003cbr/\u003e a TTL of 60 seconds or less so clients respond quickly to changes in health\u003cbr/\u003e status.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * All of the resource record sets in a group of weighted resource record\u003cbr/\u003e sets must have the same value for TTL.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If a group of weighted resource record sets includes one or more weighted\u003cbr/\u003e alias resource record sets for which the alias target is an ELB load balancer,\u003cbr/\u003e we recommend that you specify a TTL of 60 seconds for all of the non-alias\u003cbr/\u003e weighted resource record sets that have the same name and type. Values\u003cbr/\u003e other than 60 seconds (the TTL for load balancers) will change the effect\u003cbr/\u003e of the values that you specify for Weight. |\n| \u003cstrong\u003eweight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eWeighted resource record sets only: Among resource record sets that have\u003cbr/\u003ethe same combination of DNS name and type, a value that determines the proportion\u003cbr/\u003eof DNS queries that Amazon Route 53 responds to using the current resource\u003cbr/\u003erecord set. Route 53 calculates the sum of the weights for the resource record\u003cbr/\u003esets that have the same combination of DNS name and type. Route 53 then responds\u003cbr/\u003eto queries based on the ratio of a resource\u0026rsquo;s weight to the total. Note the\u003cbr/\u003efollowing:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You must specify a value for the Weight element for every weighted resource\u003cbr/\u003e record set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can only specify one ResourceRecord per weighted resource record\u003cbr/\u003e set.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can\u0026rsquo;t create latency, failover, or geolocation resource record sets\u003cbr/\u003e that have the same values for the Name and Type elements as weighted resource\u003cbr/\u003e record sets.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * You can create a maximum of 100 weighted resource record sets that have\u003cbr/\u003e the same values for the Name and Type elements.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For weighted (but not weighted alias) resource record sets, if you set\u003cbr/\u003e Weight to 0 for a resource record set, Route 53 never responds to queries\u003cbr/\u003e with the applicable value for that resource record set. However, if you\u003cbr/\u003e set Weight to 0 for all resource record sets that have the same combination\u003cbr/\u003e of DNS name and type, traffic is routed to all resources with equal probability.\u003cbr/\u003e The effect of setting Weight to 0 is different when you associate health\u003cbr/\u003e checks with weighted resource record sets. For more information, see Options\u003cbr/\u003e for Configuring Route 53 Active-Active and Active-Passive Failover (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html)\u003cbr/\u003e in the Amazon Route 53 Developer Guide. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nstatus: string\nsubmittedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html)\u003cbr/\u003eaction to get detailed information about the change.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the request. PENDING indicates that this request has\u003cbr/\u003enot yet been applied to all Amazon Route 53 DNS servers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubmittedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the change request was submitted in ISO 8601 format\u003cbr/\u003e(https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time (UTC).\u003cbr/\u003eFor example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017\u003cbr/\u003eat 17:48:16.751 UTC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:152,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/replicationgroup/",title:"ReplicationGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#ReplicationGroup"\u003eelasticache-controller/apis/v1alpha1#ReplicationGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eReplicationGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eReplicationGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ereplicationgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003ereplicationgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains all of the attributes of a specific Redis replication group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eatRestEncryptionEnabled: boolean\nauthToken: \n key: string\n name: string\n namespace: string\nautomaticFailoverEnabled: boolean\ncacheNodeType: string\ncacheParameterGroupName: string\ncacheParameterGroupRef: \n from: \n name: string\ncacheSecurityGroupNames:\n- string\ncacheSubnetGroupName: string\ncacheSubnetGroupRef: \n from: \n name: string\ndataTieringEnabled: boolean\ndescription: string\nengine: string\nengineVersion: string\nkmsKeyID: string\nlogDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n enabled: boolean\n logFormat: string\n logType: string\nmultiAZEnabled: boolean\nnodeGroupConfiguration:\n- nodeGroupID: string\n primaryAvailabilityZone: string\n primaryOutpostARN: string\n replicaAvailabilityZones:\n - string\n replicaCount: integer\n replicaOutpostARNs:\n - string\n slots: string\nnotificationTopicARN: string\nnumNodeGroups: integer\nport: integer\npreferredCacheClusterAZs:\n- string\npreferredMaintenanceWindow: string\nprimaryClusterID: string\nreplicasPerNodeGroup: integer\nreplicationGroupID: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nsnapshotARNs:\n- string\nsnapshotName: string\nsnapshotRetentionLimit: integer\nsnapshotWindow: string\ntags:\n- key: string\n value: string\ntransitEncryptionEnabled: boolean\nuserGroupIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eatRestEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag that enables encryption at rest when set to true. \u003cbr/\u003e You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group. \u003cbr/\u003e Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \u003cbr/\u003e Default: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReserved parameter. The password used to access a password protected server. \u003cbr/\u003e AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true. \u003cbr/\u003e For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup. \u003cbr/\u003e Password constraints: \u003cbr/\u003e * Must be only printable ASCII characters. \u003cbr/\u003e * Must be at least 16 characters and no more than 128 characters in length. \u003cbr/\u003e * The only permitted printable special characters are !, \u0026amp;, #, $, ^, \u0026lt;, \u0026gt;, and -. Other printable special characters cannot be used in the AUTH token. \u003cbr/\u003e For more information, see AUTH password (http://redis.io/commands/AUTH) at http://redis.io/commands/AUTH.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthToken.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailoverEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. \u003cbr/\u003e AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups. \u003cbr/\u003e Default: false\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheNodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe compute and memory capacity of the nodes in the node group (shard). \u003cbr/\u003e The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. \u003cbr/\u003e * General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward): cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge \u003cbr/\u003e * Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge \u003cbr/\u003e * Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge \u003cbr/\u003e * Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge \u003cbr/\u003e Additional node type info \u003cbr/\u003e * All current generation instance types are created in Amazon VPC by default. \u003cbr/\u003e * Redis append-only files (AOF) are not supported for T1 or T2 instances. \u003cbr/\u003e * Redis Multi-AZ with automatic failover is not supported on T1 instances. \u003cbr/\u003e * Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. \u003cbr/\u003e If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. \u003cbr/\u003e * To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2. \u003cbr/\u003e * To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSecurityGroupNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of cache security group names to associate with this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSecurityGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTieringEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA user-created description for the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache engine to be used for the clusters in this replication group. Must be Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation. \u003cbr/\u003e Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/SelectEngine.html#VersionManagement)) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the disk in the cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emultiAZEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating if you have Multi-AZ enabled to enhance fault tolerance. For more information, see Minimizing Downtime: Multi-AZ (http://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/AutoFailover.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots. \u003cbr/\u003e If you\u0026rsquo;re creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, it is required when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file. You must configure each node group (shard) using this parameter because you must specify the slots for each node group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].primaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].primaryOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaAvailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaAvailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaOutpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroupConfiguration.[].replicaOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enotificationTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent. \u003cbr/\u003e The Amazon SNS topic owner must be the same as the cluster owner.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumNodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eAn optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1. \u003cbr/\u003e Default: 1\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number on which each member of the replication group accepts connections.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredCacheClusterAZs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of EC2 Availability Zones in which the replication group\u0026rsquo;s clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list. \u003cbr/\u003e This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead. \u003cbr/\u003e If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group. \u003cbr/\u003e The number of Availability Zones listed must equal the value of NumCacheClusters. \u003cbr/\u003e Default: system chosen Availability Zones.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredCacheClusterAZs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprimaryClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available. \u003cbr/\u003e This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicasPerNodeGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eAn optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe replication group identifier. This parameter is stored as a lowercase string. \u003cbr/\u003e Constraints: \u003cbr/\u003e * A name must contain from 1 to 40 alphanumeric characters or hyphens. \u003cbr/\u003e * The first character must be a letter. \u003cbr/\u003e * A name cannot end with a hyphen or contain two consecutive hyphens.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more Amazon VPC security groups associated with this replication group. \u003cbr/\u003e Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here. \u003cbr/\u003e Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted. \u003cbr/\u003e Default: 0 (i.e., automatic backups are disabled for this cluster).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). \u003cbr/\u003e Example: 05:00-09:00 \u003cbr/\u003e If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue. Tags on replication groups will be replicated to all nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransitEncryptionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag that enables in-transit encryption when set to true. \u003cbr/\u003e You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster. \u003cbr/\u003e This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC. \u003cbr/\u003e If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup. \u003cbr/\u003e Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later. \u003cbr/\u003e Default: false \u003cbr/\u003e For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe user group to associate with the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nallowedScaleDownModifications:\n- string\nallowedScaleUpModifications:\n- string\nauthTokenEnabled: boolean\nauthTokenLastModifiedDate: string\nautoMinorVersionUpgrade: boolean\nautomaticFailover: string\nclusterEnabled: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfigurationEndpoint: \n address: string\n port: integer\ndataTiering: string\nevents:\n- date: string\n message: string\n sourceIdentifier: string\n sourceType: string\nglobalReplicationGroupInfo: \n globalReplicationGroupID: string\n globalReplicationGroupMemberRole: string\nlogDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n logFormat: string\n logType: string\n message: string\n status: string\nmemberClusters:\n- string\nmemberClustersOutpostARNs:\n- string\nmultiAZ: string\nnodeGroups:\n- nodeGroupID: string\n nodeGroupMembers:\n - cacheClusterID: string\n cacheNodeID: string\n currentRole: string\n preferredAvailabilityZone: string\n preferredOutpostARN: string\n readEndpoint: \n address: string\n port: integer\n primaryEndpoint: \n address: string\n port: integer\n readerEndpoint: \n address: string\n port: integer\n slots: string\n status: string\npendingModifiedValues: \n authTokenStatus: string\n automaticFailoverStatus: string\n logDeliveryConfigurations:\n destinationDetails: \n cloudWatchLogsDetails: \n logGroup: string\n kinesisFirehoseDetails: \n deliveryStream: string\n destinationType: string\n logFormat: string\n logType: string\n primaryClusterID: string\n resharding: \n slotMigration: \n progressPercentage: number\n userGroups: \n userGroupIDsToAdd:\n - string\n userGroupIDsToRemove:\n - string\nreplicationGroupCreateTime: string\nsnapshottingClusterID: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownModifications\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleDownModifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedScaleUpModifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthTokenLastModifiedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the auth token was last modified\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the status of automatic failover for this Redis replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eA flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups). \u003cbr/\u003e Valid values: true\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfigurationEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name of the Global datastore and role of this replication group in the Global datastore.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo.globalReplicationGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalReplicationGroupInfo.globalReplicationGroupMemberRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReturns the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReturns the destination, format and type of the logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogDeliveryConfigurations.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClusters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe names of all the cache clusters that are part of this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClusters.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememberClustersOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single node within a node group (shard).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].cacheNodeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].currentRole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].preferredAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].preferredOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].nodeGroupMembers.[].readEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].primaryEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the information required for client programs to connect to a cache node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint.address\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].readerEndpoint.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeGroups.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA group of settings to be applied to the replication group, either immediately or during the next maintenance window.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.authTokenStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.automaticFailoverStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log delivery configurations being modified\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the CloudWatch Logs destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details of the Kinesis Data Firehose destination.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].destinationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].logFormat\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.logDeliveryConfigurations.[].logType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.primaryClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding.slotMigration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the progress of an online resharding operation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.resharding.slotMigration.progressPercentage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the user group update.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingModifiedValues.userGroups.userGroupIDsToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshottingClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cluster ID that is used as the daily snapshot source for the replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:153,href:"https://aws-controllers-k8s.github.io/community/reference/ecr/v1alpha1/repository/",title:"Repository",description:null,content:'\u003cp\u003e\u003ccode\u003eecr.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecr-controller/apis/v1alpha1#Repository"\u003eecr-controller/apis/v1alpha1#Repository\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRepository\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRepositoryList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erepositories\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erepository\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn object representing a repository.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eencryptionConfiguration: \n encryptionType: string\n kmsKey: string\nimageScanningConfiguration: \n scanOnPush: boolean\nimageTagMutability: string\nlifecyclePolicy: string\nname: string\npolicy: string\nregistryID: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe encryption configuration for the repository. This determines how the\u003cbr/\u003econtents of your repository are encrypted at rest.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.encryptionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageScanningConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe image scanning configuration for the repository. This determines whether\u003cbr/\u003eimages are scanned for known vulnerabilities after being pushed to the repository.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageScanningConfiguration.scanOnPush\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageTagMutability\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe tag mutability setting for the repository. If this parameter is omitted,\u003cbr/\u003ethe default setting of MUTABLE will be used which will allow image tags to\u003cbr/\u003ebe overwritten. If IMMUTABLE is specified, all image tags within the repository\u003cbr/\u003ewill be immutable which will prevent them from being overwritten.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elifecyclePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON repository policy text to apply to the repository.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name to use for the repository. The repository name may be specified\u003cbr/\u003eon its own (such as nginx-web-app) or it can be prepended with a namespace\u003cbr/\u003eto group the repository into a category (such as project-a/nginx-web-app).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe JSON repository policy text to apply to the repository. For more information,\u003cbr/\u003esee Amazon ECR repository policies (https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html)\u003cbr/\u003ein the Amazon Elastic Container Registry User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregistryID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID associated with the registry to create\u003cbr/\u003ethe repository. If you do not specify a registry, the default registry is\u003cbr/\u003eassumed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the repository to help you categorize and\u003cbr/\u003eorganize them. Each tag consists of a key and an optional value, both of\u003cbr/\u003ewhich you define. Tag keys can have a maximum character length of 128 characters,\u003cbr/\u003eand tag values can have a maximum length of 256 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata to apply to a resource to help you categorize and organize them.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEach tag consists of a key and a value, both of which you define. Tag keys\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan have a maximum character length of 128 characters, and tag values can\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ehave a maximum length of 256 characters.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\nrepositoryURI: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in JavaScript date format, when the repository was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erepositoryURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe URI for the repository. You can use this URI for container image push\u003cbr/\u003eand pull operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:154,href:"https://aws-controllers-k8s.github.io/community/reference/route53resolver/v1alpha1/resolverendpoint/",title:"ResolverEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53resolver.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53resolver-controller/apis/v1alpha1#ResolverEndpoint"\u003eroute53resolver-controller/apis/v1alpha1#ResolverEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIn the response to a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html),\nDeleteResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html),\nGetResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html),\nUpdates the name, or ResolverEndpointType for an endpoint, or UpdateResolverEndpoint\n(https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html)\nrequest, a complex type that contains settings for an existing inbound or\noutbound Resolver endpoint.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edirection: string\nipAddresses:\n- ip: string\n ipv6: string\n subnetID: string\n subnetRef: \n from: \n name: string\nname: string\nresolverEndpointType: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edirection\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecify the applicable value:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * INBOUND: Resolver forwards DNS queries to the DNS service for a VPC\u003cbr/\u003e from your network\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC\u003cbr/\u003e to your network\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe subnets and IP addresses in your VPC that DNS queries originate from\u003cbr/\u003e(for outbound endpoints) or that you forward DNS queries to (for inbound\u003cbr/\u003eendpoints). The subnet ID uniquely identifies a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn a CreateResolverEndpoint (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, the IP address that DNS queries originate from (for outbound endpoints)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor that you forward DNS queries to (for inbound endpoints). IpAddressRequest\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ealso includes the ID of the subnet that contains the IP address.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].ipv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for SubnetID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddresses.[].subnetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name that lets you easily find a configuration in the Resolver\u003cbr/\u003edashboard in the Route 53 console.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolverEndpointType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor the endpoint type you can choose either IPv4, IPv6. or dual-stack. A\u003cbr/\u003edual-stack endpoint means that it will resolve via both IPv4 and IPv6. This\u003cbr/\u003eendpoint type is applied to all IP addresses.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe ID of one or more security groups that you want to use to control access\u003cbr/\u003eto this VPC. The security group that you specify must include one or more\u003cbr/\u003einbound rules (for inbound Resolver endpoints) or outbound rules (for outbound\u003cbr/\u003eResolver endpoints). Inbound and outbound rules must allow TCP and UDP access.\u003cbr/\u003eFor inbound access, open port 53. For outbound access, open the port that\u003cbr/\u003eyou\u0026rsquo;re using for DNS queries on your network.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the tag keys and values that you want to associate with the endpoint. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne tag that you want to add to the specified resource. A tag consists of\na Key (a name for the tag) and a Value. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncreatorRequestID: string\nhostVPCID: string\nid: string\nipAddressCount: integer\nmodificationTime: string\nstatus: string\nstatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was created, in Unix time format and\u003cbr/\u003eCoordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique string that identifies the request that created the Resolver endpoint.\u003cbr/\u003eThe CreatorRequestId allows failed requests to be retried without the risk\u003cbr/\u003eof running the operation twice.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostVPCID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC that you want to create the Resolver endpoint in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Resolver endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of IP addresses that the Resolver endpoint can use for DNS queries.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodificationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was last modified, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA code that specifies the current status of the Resolver endpoint. Valid\u003cbr/\u003evalues include the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING: Resolver is creating and configuring one or more Amazon VPC\u003cbr/\u003e network interfaces for this endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * OPERATIONAL: The Amazon VPC network interfaces for this endpoint are\u003cbr/\u003e correctly configured and able to pass inbound or outbound DNS queries\u003cbr/\u003e between your network and Resolver.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING: Resolver is associating or disassociating one or more network\u003cbr/\u003e interfaces with this endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AUTO_RECOVERING: Resolver is trying to recover one or more of the network\u003cbr/\u003e interfaces that are associated with this endpoint. During the recovery\u003cbr/\u003e process, the endpoint functions with limited capacity because of the limit\u003cbr/\u003e on the number of DNS queries per IP address (per network interface). For\u003cbr/\u003e the current limit, see Limits on Route 53 Resolver (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTION_NEEDED: This endpoint is unhealthy, and Resolver can\u0026rsquo;t automatically\u003cbr/\u003e recover it. To resolve the problem, we recommend that you check each IP\u003cbr/\u003e address that you associated with the endpoint. For each IP address that\u003cbr/\u003e isn\u0026rsquo;t available, add another IP address and then delete the IP address\u003cbr/\u003e that isn\u0026rsquo;t available. (An endpoint must always include at least two IP\u003cbr/\u003e addresses.) A status of ACTION_NEEDED can have a variety of causes. Here\u003cbr/\u003e are two common causes: One or more of the network interfaces that are\u003cbr/\u003e associated with the endpoint were deleted using Amazon VPC. The network\u003cbr/\u003e interface couldn\u0026rsquo;t be created for some reason that\u0026rsquo;s outside the control\u003cbr/\u003e of Resolver.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING: Resolver is deleting this endpoint and the associated network\u003cbr/\u003e interfaces.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA detailed description of the status of the Resolver endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:155,href:"https://aws-controllers-k8s.github.io/community/reference/route53resolver/v1alpha1/resolverrule/",title:"ResolverRule",description:null,content:'\u003cp\u003e\u003ccode\u003eroute53resolver.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/route53resolver-controller/apis/v1alpha1#ResolverRule"\u003eroute53resolver-controller/apis/v1alpha1#ResolverRule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResolverRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverrules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresolverrule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor queries that originate in your VPC, detailed information about a Resolver\nrule, which specifies how to route DNS queries out of the VPC. The ResolverRule\nparameter appears in the response to a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html),\nDeleteResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html),\nGetResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html),\nListResolverRules (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html),\nor UpdateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html)\nrequest.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassociations:\n- id: string\n name: string\n resolverRuleID: string\n status: string\n statusMessage: string\n vpcID: string\ndomainName: string\nname: string\nresolverEndpointID: string\nruleType: string\ntags:\n- key: string\n value: string\ntargetIPs:\n- ip: string\n ipv6: string\n port: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn the response to an AssociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html),\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDisassociateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html),\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor ListResolverRuleAssociations (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, provides information about an association between a Resolver rule\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand a VPC. The association determines which DNS queries that originate in\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe VPC are forwarded to your network.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].resolverRuleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eDNS queries for this domain name are forwarded to the IP addresses that you\u003cbr/\u003especify in TargetIps. If a query matches multiple Resolver rules (example.com\u003cbr/\u003eand www.example.com), outbound DNS queries are routed using the Resolver\u003cbr/\u003erule that contains the most specific domain name (www.example.com).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA friendly name that lets you easily find a rule in the Resolver dashboard\u003cbr/\u003ein the Route 53 console.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresolverEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the outbound Resolver endpoint that you want to use to route DNS\u003cbr/\u003equeries to the IP addresses that you specify in TargetIps.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleType\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen you want to forward DNS queries for specified domain name to resolvers\u003cbr/\u003eon your network, specify FORWARD.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you have a forwarding rule to forward DNS queries for a domain to your\u003cbr/\u003enetwork and you want Resolver to process queries for a subdomain of that\u003cbr/\u003edomain, specify SYSTEM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor example, to forward DNS queries for example.com to resolvers on your\u003cbr/\u003enetwork, you create a rule and specify FORWARD for RuleType. To then have\u003cbr/\u003eResolver process queries for apex.example.com, you create a rule and specify\u003cbr/\u003eSYSTEM for RuleType.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCurrently, only Resolver can create rules that have a value of RECURSIVE\u003cbr/\u003efor RuleType.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the tag keys and values that you want to associate with the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne tag that you want to add to the specified resource. A tag consists of\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea Key (a name for the tag) and a Value.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe IPs that you want Resolver to forward DNS queries to. You can specify\u003cbr/\u003eonly IPv4 addresses. Separate IP addresses with a space.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTargetIps is available only when the value of Rule type is FORWARD.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIn a CreateResolverRule (https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequest, an array of the IPs that you want to forward DNS queries to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[].ipv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetIPs.[].port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ncreatorRequestID: string\nid: string\nmodificationTime: string\nownerID: string\nshareStatus: string\nstatus: string\nstatusMessage: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Resolver rule was created, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatorRequestID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA unique string that you specified when you created the Resolver rule. CreatorRequestId\u003cbr/\u003eidentifies the request and allows failed requests to be retried without the\u003cbr/\u003erisk of running the operation twice.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID that Resolver assigned to the Resolver rule when you created it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodificationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the Resolver rule was last updated, in Unix time format\u003cbr/\u003eand Coordinated Universal Time (UTC).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhen a rule is shared with another Amazon Web Services account, the account\u003cbr/\u003eID of the account that the rule is shared with.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshareStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eWhether the rule is shared and, if so, whether the current account is sharing\u003cbr/\u003ethe rule with another account, or another account is sharing the rule with\u003cbr/\u003ethe current account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA code that specifies the current status of the Resolver rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA detailed description of the status of a Resolver rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:156,href:"https://aws-controllers-k8s.github.io/community/reference/cloudfront/v1alpha1/responseheaderspolicy/",title:"ResponseHeadersPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudfront.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudfront-controller/apis/v1alpha1#ResponseHeadersPolicy"\u003ecloudfront-controller/apis/v1alpha1#ResponseHeadersPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResponseHeadersPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eResponseHeadersPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresponseheaderspolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eresponseheaderspolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA response headers policy.\u003c/p\u003e\n\u003cp\u003eA response headers policy contains information about a set of HTTP response\nheaders.\u003c/p\u003e\n\u003cp\u003eAfter you create a response headers policy, you can use its ID to attach\nit to one or more cache behaviors in a CloudFront distribution. When it\u0026rsquo;s\nattached to a cache behavior, the response headers policy affects the HTTP\nheaders that CloudFront includes in HTTP responses to requests that match\nthe cache behavior. CloudFront adds or removes response headers according\nto the configuration of the response headers policy.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding or removing HTTP headers in CloudFront responses\n(https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/modifying-response-headers.html)\nin the Amazon CloudFront Developer Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eresponseHeadersPolicyConfig: \n comment: string\n corsConfig: \n accessControlAllowCredentials: boolean\n accessControlAllowHeaders: \n items:\n - string\n accessControlAllowMethods: \n items:\n - string\n accessControlAllowOrigins: \n items:\n - string\n accessControlExposeHeaders: \n items:\n - string\n accessControlMaxAgeSec: integer\n originOverride: boolean\n customHeadersConfig: \n items:\n - header: string\n override: boolean\n value: string\n name: string\n removeHeadersConfig: \n items:\n - header: string\n securityHeadersConfig: \n contentSecurityPolicy: \n contentSecurityPolicy: string\n override: boolean\n contentTypeOptions: \n override: boolean\n frameOptions: \n frameOption: string\n override: boolean\n referrerPolicy: \n override: boolean\n referrerPolicy: string\n strictTransportSecurity: \n accessControlMaxAgeSec: integer\n includeSubdomains: boolean\n override: boolean\n preload: boolean\n xSSProtection: \n modeBlock: boolean\n override: boolean\n protection: boolean\n reportURI: string\n serverTimingHeadersConfig: \n enabled: boolean\n samplingRate: number\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains metadata about the response headers policy, and a set of configurations\u003cbr/\u003ethat specify the HTTP headers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.comment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a set of HTTP response headers that are used for cross-origin\u003cbr/\u003eresource sharing (CORS). CloudFront adds these headers to HTTP responses\u003cbr/\u003ethat it sends for CORS requests that match a cache behavior associated with\u003cbr/\u003ethis response headers policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CORS, see Cross-Origin Resource Sharing (CORS)\u003cbr/\u003e(https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) in the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowCredentials\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP header names that CloudFront includes as values for the Access-Control-Allow-Headers\u003cbr/\u003eHTTP response header.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Access-Control-Allow-Headers HTTP response\u003cbr/\u003eheader, see Access-Control-Allow-Headers (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowMethods.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowMethods.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowOrigins.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlAllowOrigins.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlExposeHeaders.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.accessControlExposeHeaders.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.corsConfig.originOverride\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP response header names and their values. CloudFront includes\u003cbr/\u003ethese headers in HTTP responses that it sends for requests that match a cache\u003cbr/\u003ebehavior that\u0026rsquo;s associated with this response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn HTTP response header name and its value. CloudFront includes this header\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein HTTP responses that it sends for requests that match a cache behavior\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat\u0026rsquo;s associated with this response headers policy.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[].override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.customHeadersConfig.items.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of HTTP header names that CloudFront removes from HTTP responses to\u003cbr/\u003erequests that match the cache behavior that this response headers policy\u003cbr/\u003eis attached to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig.items\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.removeHeadersConfig.items.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe name of an HTTP header that CloudFront removes from HTTP responses to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erequests that match the cache behavior that this response headers policy\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eis attached to.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a set of security-related HTTP response headers. CloudFront\u003cbr/\u003eadds these headers to HTTP responses that it sends for requests that match\u003cbr/\u003ea cache behavior associated with this response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe policy directives and their values that CloudFront includes as values\u003cbr/\u003efor the Content-Security-Policy HTTP response header.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Content-Security-Policy HTTP response header,\u003cbr/\u003esee Content-Security-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy.contentSecurityPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentSecurityPolicy.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentTypeOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-Content-Type-Options HTTP response\u003cbr/\u003eheader with its value set to nosniff.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-Content-Type-Options HTTP response header,\u003cbr/\u003esee X-Content-Type-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.contentTypeOptions.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-Frame-Options HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-Frame-Options HTTP response header, see\u003cbr/\u003eX-Frame-Options (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions.frameOption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.frameOptions.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the Referrer-Policy HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Referrer-Policy HTTP response header, see\u003cbr/\u003eReferrer-Policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.referrerPolicy.referrerPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the Strict-Transport-Security HTTP\u003cbr/\u003eresponse header and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the Strict-Transport-Security HTTP response header,\u003cbr/\u003esee Strict-Transport-Security (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.accessControlMaxAgeSec\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.includeSubdomains\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.strictTransportSecurity.preload\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetermines whether CloudFront includes the X-XSS-Protection HTTP response\u003cbr/\u003eheader and the header\u0026rsquo;s value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about the X-XSS-Protection HTTP response header, see\u003cbr/\u003eX-XSS-Protection (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection)\u003cbr/\u003ein the MDN Web Docs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.modeBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.override\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.protection\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.securityHeadersConfig.xSSProtection.reportURI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for enabling the Server-Timing header in HTTP responses sent\u003cbr/\u003efrom CloudFront. CloudFront adds this header to HTTP responses that it sends\u003cbr/\u003ein response to requests that match a cache behavior that\u0026rsquo;s associated with\u003cbr/\u003ethis response headers policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can use the Server-Timing header to view metrics that can help you gain\u003cbr/\u003einsights about the behavior and performance of CloudFront. For example, you\u003cbr/\u003ecan see which cache layer served a cache hit, or the first byte latency from\u003cbr/\u003ethe origin when there was a cache miss. You can use the metrics in the Server-Timing\u003cbr/\u003eheader to troubleshoot issues or test the efficiency of your CloudFront configuration.\u003cbr/\u003eFor more information, see Server-Timing header (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/understanding-response-headers-policies.html#server-timing-header)\u003cbr/\u003ein the Amazon CloudFront Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig.enabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresponseHeadersPolicyConfig.serverTimingHeadersConfig.samplingRate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neTag: string\nid: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeTag\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier for the response headers policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the response headers policy was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:157,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/role/",title:"Role",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#Role"\u003eiam-controller/apis/v1alpha1#Role\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRole\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRoleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erole\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM role. This structure is returned as a response\nelement in several API operations that interact with roles.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassumeRolePolicyDocument: string\ndescription: string\ninlinePolicies: {}\nmaxSessionDuration: integer\nname: string\npath: string\npermissionsBoundary: string\npermissionsBoundaryRef: \n from: \n name: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassumeRolePolicyDocument\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe trust relationship policy document that grants an entity permission to\u003cbr/\u003eassume the role.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIn IAM, you must provide a JSON policy that has been converted to a string.\u003cbr/\u003eHowever, for CloudFormation templates formatted in YAML, you can provide\u003cbr/\u003ethe policy in JSON or YAML format. CloudFormation always converts a YAML\u003cbr/\u003epolicy to JSON format before submitting it to IAM.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe regex pattern (http://wikipedia.org/wiki/regex) used to validate this\u003cbr/\u003eparameter is a string of characters consisting of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Any printable ASCII character ranging from the space character (\\u0020)\u003cbr/\u003e through the end of the ASCII character range\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The printable characters in the Basic Latin and Latin-1 Supplement character\u003cbr/\u003e set (through \\u00FF)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The special characters tab (\\u0009), line feed (\\u000A), and carriage\u003cbr/\u003e return (\\u000D)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUpon success, the response includes the same trust policy in JSON format.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxSessionDuration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum session duration (in seconds) that you want to set for the specified\u003cbr/\u003erole. If you do not specify a value for this setting, the default value of\u003cbr/\u003eone hour is applied. This setting can have a value from 1 hour to 12 hours.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAnyone who assumes the role from the CLI or API can use the DurationSeconds\u003cbr/\u003eAPI parameter or the duration-seconds CLI parameter to request a longer session.\u003cbr/\u003eThe MaxSessionDuration setting determines the maximum duration that can be\u003cbr/\u003erequested using the DurationSeconds parameter. If users don\u0026rsquo;t specify a value\u003cbr/\u003efor the DurationSeconds parameter, their security credentials are valid for\u003cbr/\u003eone hour by default. This applies when you use the AssumeRole* API operations\u003cbr/\u003eor the assume-role* CLI operations but does not apply when you use those\u003cbr/\u003eoperations to create a console URL. For more information, see Using IAM roles\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the\u003cbr/\u003eIAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the role to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of upper and lowercase alphanumeric characters\u003cbr/\u003ewith no spaces. You can also include any of the following characters: _+=,.@-\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path to the role. For more information about paths, see IAM Identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the managed policy that is used to set the permissions boundary\u003cbr/\u003efor the role.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA permissions boundary policy defines the maximum permissions that identity-based\u003cbr/\u003epolicies can grant to an entity, but does not grant permissions. Permissions\u003cbr/\u003eboundaries do not define the maximum permissions that a resource-based policy\u003cbr/\u003ecan grant to an entity. To learn more, see Permissions boundaries for IAM\u003cbr/\u003eentities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about policy types, see Policy types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new role. Each tag consists\u003cbr/\u003eof a key name and an associated value. For more information about tagging,\u003cbr/\u003esee Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\nwith an IAM resource. For more information about tagging, see Tagging IAM\nresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\nin the IAM User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\nroleID: string\nroleLastUsed: \n lastUsedDate: string\n region: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the role was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the role. For more information about\u003cbr/\u003eIDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the last time that an IAM role was used. This\u003cbr/\u003eincludes the date and time and the Region in which the role was last used.\u003cbr/\u003eActivity is only reported for the trailing 400 days. This period can be shorter\u003cbr/\u003eif your Region began supporting these features within the last year. The\u003cbr/\u003erole might have been used more than 400 days ago. For more information, see\u003cbr/\u003eRegions where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period)\u003cbr/\u003ein the IAM user Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed.lastUsedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleLastUsed.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:158,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/route/",title:"Route",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Route"\u003eapigatewayv2-controller/apis/v1alpha1#Route\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRoute\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutes\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroute\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a route.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eapiID: string\napiKeyRequired: boolean\napiRef: \n from: \n name: string\nauthorizationScopes:\n- string\nauthorizationType: string\nauthorizerID: string\nauthorizerRef: \n from: \n name: string\nmodelSelectionExpression: string\noperationName: string\nrequestModels: {}\nrequestParameters: {}\nrouteKey: string\nrouteResponseSelectionExpression: string\ntarget: string\ntargetRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiKeyRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizationScopes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizationScopes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthorizerRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoperationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestModels\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequestParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteKey\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteResponseSelectionExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etarget\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargetRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nrouteID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:159,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/routetable/",title:"RouteTable",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#RouteTable"\u003eec2-controller/apis/v1alpha1#RouteTable\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRouteTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutetables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eroutetable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a route table.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eroutes:\n- carrierGatewayID: string\n coreNetworkARN: string\n destinationCIDRBlock: string\n destinationIPv6CIDRBlock: string\n destinationPrefixListID: string\n egressOnlyInternetGatewayID: string\n gatewayID: string\n gatewayRef: \n from: \n name: string\n instanceID: string\n localGatewayID: string\n natGatewayID: string\n natGatewayRef: \n from: \n name: string\n networkInterfaceID: string\n transitGatewayID: string\n transitGatewayRef: \n from: \n name: string\n vpcEndpointID: string\n vpcEndpointRef: \n from: \n name: string\n vpcPeeringConnectionID: string\n vpcPeeringConnectionRef: \n from: \n name: string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].coreNetworkARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationCIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].destinationPrefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].egressOnlyInternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for GatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].gatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].instanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].localGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for NATGatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].natGatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for TransitGatewayID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].transitGatewayRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for VPCEndpointID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcEndpointRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReference field for VPCPeeringConnectionID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroutes.[].vpcPeeringConnectionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nassociations:\n associationState: \n state: string\n statusMessage: string\n gatewayID: string\n main: boolean\n routeTableAssociationID: string\n routeTableID: string\n subnetID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nownerID: string\npropagatingVGWs:\n- gatewayID: string\nrouteStatuses:\n- carrierGatewayID: string\n coreNetworkARN: string\n destinationCIDRBlock: string\n destinationIPv6CIDRBlock: string\n destinationPrefixListID: string\n egressOnlyInternetGatewayID: string\n gatewayID: string\n instanceID: string\n instanceOwnerID: string\n localGatewayID: string\n natGatewayID: string\n networkInterfaceID: string\n origin: string\n state: string\n transitGatewayID: string\n vpcPeeringConnectionID: string\nrouteTableID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe associations between the route table and one or more subnets or a gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a route table and a subnet or gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].associationState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].associationState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].main\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].routeTableAssociationID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].routeTableID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassociations.[].subnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epropagatingVGWs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAny virtual private gateway (VGW) propagating routes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epropagatingVGWs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a virtual private gateway propagating route.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe routes in the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a route in a route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].coreNetworkARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationCIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].destinationPrefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].egressOnlyInternetGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].gatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].instanceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].instanceOwnerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].localGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].natGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].networkInterfaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].origin\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].transitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteStatuses.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the route table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:160,href:"https://aws-controllers-k8s.github.io/community/reference/eventbridge/v1alpha1/rule/",title:"Rule",description:null,content:'\u003cp\u003e\u003ccode\u003eeventbridge.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/eventbridge-controller/apis/v1alpha1#Rule"\u003eeventbridge-controller/apis/v1alpha1#Rule\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erules\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erule\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a rule in Amazon EventBridge.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\neventBusName: string\neventBusRef: \n from: \n name: string\neventPattern: string\nname: string\nroleARN: string\nscheduleExpression: string\nstate: string\ntags:\n- key: string\n value: string\ntargets:\n- arn: string\n batchParameters: \n arrayProperties: \n size: integer\n jobDefinition: string\n jobName: string\n retryStrategy: \n attempts: integer\n deadLetterConfig: \n arn: string\n ecsParameters: \n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n enableECSManagedTags: boolean\n enableExecuteCommand: boolean\n group: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n placementConstraints:\n - expression: string\n type_: string\n placementStrategy:\n - field: string\n type_: string\n platformVersion: string\n propagateTags: string\n referenceID: string\n tags:\n - key: string\n value: string\n taskCount: integer\n taskDefinitionARN: string\n httpParameters: \n headerParameters: {}\n pathParameterValues:\n - string\n queryStringParameters: {}\n id: string\n input: string\n inputPath: string\n inputTransformer: \n inputPathsMap: {}\n inputTemplate: string\n kinesisParameters: \n partitionKeyPath: string\n redshiftDataParameters: \n database: string\n dbUser: string\n secretManagerARN: string\n sql: string\n sqls:\n - string\n statementName: string\n withEvent: boolean\n retryPolicy: \n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n roleARN: string\n runCommandParameters: \n runCommandTargets:\n - key: string\n values:\n - string\n sageMakerPipelineParameters: \n pipelineParameterList:\n - name: string\n value: string\n sqsParameters: \n messageGroupID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or ARN of the event bus to associate with this rule. If you omit\u003cbr/\u003ethis, the default event bus is used.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventBusRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeventPattern\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe event pattern. For more information, see Amazon EventBridge event patterns\u003cbr/\u003e(https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html)\u003cbr/\u003ein the Amazon EventBridge User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the rule that you are creating or updating.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role associated with the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re setting an event bus in another account as the target and that\u003cbr/\u003eaccount granted permission to your account through an organization instead\u003cbr/\u003eof directly by the account ID, you must specify a RoleArn with proper permissions\u003cbr/\u003ein the Target structure, instead of here in this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escheduleExpression\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scheduling expression. For example, \u0026ldquo;cron(0 20 * * ? *)\u0026rdquo; or \u0026ldquo;rate(5 minutes)\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values include:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DISABLED: The rule is disabled. EventBridge does not match any events\u003cbr/\u003e against the rule.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ENABLED: The rule is enabled. EventBridge matches events against the\u003cbr/\u003e rule, except for Amazon Web Services management events delivered through\u003cbr/\u003e CloudTrail.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for\u003cbr/\u003e all events, including Amazon Web Services management events delivered\u003cbr/\u003e through CloudTrail. Management events provide visibility into management\u003cbr/\u003e operations that are performed on resources in your Amazon Web Services\u003cbr/\u003e account. These are also known as control plane operations. For more information,\u003cbr/\u003e see Logging management events (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events)\u003cbr/\u003e in the CloudTrail User Guide, and Filtering management events from Amazon\u003cbr/\u003e Web Services services (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail)\u003cbr/\u003e in the Amazon EventBridge User Guide. This value is only valid for rules\u003cbr/\u003e on the default (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses)\u003cbr/\u003e event bus or custom event buses (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html).\u003cbr/\u003e It does not apply to partner event buses (https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of key-value pairs to associate with the rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003erules and event buses support tagging.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etargets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTargets are the resources to be invoked when a rule is triggered. For a complete\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003elist of services and resources that can be set as a target, see PutTargets\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutTargets.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eIf you are setting the event bus of another account as the target, and that\naccount granted permission to your account through an organization instead\nof directly by the account ID, then you must specify a RoleArn with proper\npermissions in the Target structure. For more information, see Sending and\nReceiving Events Between Amazon Web Services Accounts (https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html)\nin the Amazon EventBridge User Guide. || \u003cstrong\u003etargets.[].arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe custom parameters to be used when the target is an Batch job. |\n| \u003cstrong\u003etargets.[].batchParameters.arrayProperties\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe array properties for the submitted job, such as the size of the array.\u003cbr/\u003eThe array size can be between 2 and 10,000. If you specify array properties\u003cbr/\u003efor a job, it becomes an array job. This parameter is used only if the target\u003cbr/\u003eis an Batch job. |\n| \u003cstrong\u003etargets.[].batchParameters.arrayProperties.size\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.jobDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.jobName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].batchParameters.retryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe retry strategy to use for failed jobs, if the target is an Batch job.\u003cbr/\u003eIf you specify a retry strategy here, it overrides the retry strategy defined\u003cbr/\u003ein the job definition. |\n| \u003cstrong\u003etargets.[].batchParameters.retryStrategy.attempts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].deadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA DeadLetterConfig object that contains information about a dead-letter queue\u003cbr/\u003econfiguration. |\n| \u003cstrong\u003etargets.[].deadLetterConfig.arn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe custom parameters to be used when the target is an Amazon ECS task. |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem\n(https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CapacityProviderStrategyItem.html)\nin the Amazon ECS API Reference. || \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.enableECSManagedTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.enableExecuteCommand\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.group\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the network configuration for an ECS task. |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis structure specifies the VPC subnets and security groups for the task,\u003cbr/\u003eand whether a public IP address is to be used. This structure is relevant\u003cbr/\u003eonly for ECS tasks that use the awsvpc network mode. |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etargets.[].ecsParameters.placementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargets.[].ecsParameters.placementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a constraint on task placement. To learn more, see\nTask Placement Constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003etargets.[].ecsParameters.placementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementConstraints.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eThe task placement strategy for a task or service. To learn more, see Task\nPlacement Strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Service Developer Guide. || **targets.[].ecsParameters.placementStrategy.[].field**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.placementStrategy.[].type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.platformVersion**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.propagateTags**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.referenceID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eA key-value pair associated with an Amazon Web Services resource. In EventBridge,\nrules and event buses support tagging. || **targets.[].ecsParameters.tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].ecsParameters.taskCount**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].ecsParameters.taskDefinitionARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].httpParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameter to be used when the target is an API Gateway APIs\u003cbr/\u003eor EventBridge ApiDestinations. In the latter case, these are merged with\u003cbr/\u003eany InvocationParameters specified on the Connection, with any values from\u003cbr/\u003ethe Connection taking precedence. |\n| **targets.[].httpParameters.headerParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].httpParameters.pathParameterValues**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].httpParameters.pathParameterValues.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].httpParameters.queryStringParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].id**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].input**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].inputPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].inputTransformer**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eContains the parameters needed for you to provide custom input to a target\u003cbr/\u003ebased on one or more pieces of data extracted from the event. |\n| **targets.[].inputTransformer.inputPathsMap**\u003cbr/\u003eOptional | **object**\u003cbr/\u003e |\n| **targets.[].inputTransformer.inputTemplate**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].kinesisParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis object enables you to specify a JSON path to extract from the event\u003cbr/\u003eand use as the partition key for the Amazon Kinesis data stream, so that\u003cbr/\u003eyou can control the shard to which the event goes. If you do not include\u003cbr/\u003ethis parameter, the default is to use the eventId as the partition key. |\n| **targets.[].kinesisParameters.partitionKeyPath**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].redshiftDataParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to be used when the target is a Amazon Redshift\u003cbr/\u003ecluster to invoke the Amazon Redshift Data API ExecuteStatement based on\u003cbr/\u003eEventBridge events. |\n| **targets.[].redshiftDataParameters.database**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eRedshift Database |\n| **targets.[].redshiftDataParameters.dbUser**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eDatabase user name |\n| **targets.[].redshiftDataParameters.secretManagerARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eOptional SecretManager ARN which stores the database credentials |\n| **targets.[].redshiftDataParameters.sql**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eA single Redshift SQL |\n| **targets.[].redshiftDataParameters.sqls**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eA list of SQLs. |\n| **targets.[].redshiftDataParameters.sqls.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].redshiftDataParameters.statementName**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eA name for Redshift DataAPI statement which can be used as filter of ListStatement. |\n| **targets.[].redshiftDataParameters.withEvent**\u003cbr/\u003eOptional | **boolean**\u003cbr/\u003e |\n| **targets.[].retryPolicy**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eA RetryPolicy object that includes information about the retry policy settings. |\n| **targets.[].retryPolicy.maximumEventAgeInSeconds**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].retryPolicy.maximumRetryAttempts**\u003cbr/\u003eOptional | **integer**\u003cbr/\u003e |\n| **targets.[].roleARN**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].runCommandParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis parameter contains the criteria (either InstanceIds or a tag) used to\u003cbr/\u003especify which EC2 instances are to be sent the command. |\n| **targets.[].runCommandParameters.runCommandTargets**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eInformation about the EC2 instances that are to be sent the command, specified\nas key-value pairs. Each RunCommandTarget block can include only one key,\nbut this key may specify multiple values. || **targets.[].runCommandParameters.runCommandTargets.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[].values**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].runCommandParameters.runCommandTargets.[].values.[]**\u003cbr/\u003eRequired | **string**\u003cbr/\u003e || **targets.[].sageMakerPipelineParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThese are custom parameters to use when the target is a SageMaker Model Building\u003cbr/\u003ePipeline that starts based on EventBridge events. |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList**\u003cbr/\u003eOptional | **array**\u003cbr/\u003e |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eName/Value pair of a parameter to start execution of a SageMaker Model Building\nPipeline. || **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].sageMakerPipelineParameters.pipelineParameterList.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **targets.[].sqsParameters**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eThis structure includes the custom parameter to be used when the target is\u003cbr/\u003ean SQS FIFO queue. |\n| **targets.[].sqsParameters.messageGroupID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:161,href:"https://aws-controllers-k8s.github.io/community/reference/networkfirewall/v1alpha1/rulegroup/",title:"RuleGroup",description:null,content:'\u003cp\u003e\u003ccode\u003enetworkfirewall.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/networkfirewall-controller/apis/v1alpha1#RuleGroup"\u003enetworkfirewall-controller/apis/v1alpha1#RuleGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe object that defines the rules in a rule group. This, along with RuleGroupResponse,\ndefine the rule group. You can retrieve all objects for a rule group by calling\nDescribeRuleGroup.\u003c/p\u003e\n\u003cp\u003eNetwork Firewall uses a rule group to inspect and control network traffic.\nYou define stateless rule groups to inspect individual packets and you define\nstateful rule groups to inspect packets in the context of their traffic flow.\u003c/p\u003e\n\u003cp\u003eTo use a rule group, you include it by reference in an Network Firewall firewall\npolicy, then you use the policy in a firewall. You can reference a rule group\nfrom more than one firewall policy, and you can use a firewall policy in\nmore than one firewall.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eanalyzeRuleGroup: boolean\ncapacity: integer\ndescription: string\ndryRun: boolean\nencryptionConfiguration: \n keyID: string\n type_: string\nruleGroup: \n referenceSets: \n iPSetReferences: {}\n ruleVariables: \n iPSets: {}\n portSets: {}\n rulesSource: \n rulesSourceList: \n generatedRulesType: string\n targetTypes:\n - string\n targets:\n - string\n rulesString: string\n statefulRules:\n - action: string\n header: \n destination: string\n destinationPort: string\n direction: string\n protocol: string\n source: string\n sourcePort: string\n ruleOptions:\n - keyword: string\n settings:\n - string\n statelessRulesAndCustomActions: \n customActions:\n actionDefinition: \n publishMetricAction: \n dimensions:\n - value: string\n actionName: string\n statelessRules:\n - priority: integer\n ruleDefinition: \n actions:\n - string\n matchAttributes: \n destinationPorts:\n - fromPort: integer\n toPort: integer\n destinations:\n - addressDefinition: string\n protocols:\n - integer\n sourcePorts:\n - fromPort: integer\n toPort: integer\n sources:\n - addressDefinition: string\n tcpFlags:\n flags:\n - string\n masks:\n - string\n statefulRuleOptions: \n ruleOrder: string\nruleGroupName: string\nrules: string\nsourceMetadata: \n sourceARN: string\n sourceUpdateToken: string\ntags:\n- key: string\n value: string\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eanalyzeRuleGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want Network Firewall to analyze the stateless rules\u003cbr/\u003ein the rule group for rule behavior such as asymmetric routing. If set to\u003cbr/\u003eTRUE, Network Firewall runs the analysis and then creates the rule group\u003cbr/\u003efor you. To run the stateless rule group analyzer without creating the rule\u003cbr/\u003egroup, set DryRun to TRUE.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacity\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum operating resources that this rule group can use. Rule group\u003cbr/\u003ecapacity is fixed at creation. When you update a rule group, you are limited\u003cbr/\u003eto this capacity. When you reference a rule group from a firewall policy,\u003cbr/\u003eNetwork Firewall reserves this capacity for the rule group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can retrieve the capacity that would be required for a rule group before\u003cbr/\u003eyou create the rule group by calling CreateRuleGroup with DryRun set to TRUE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can\u0026rsquo;t change or exceed this capacity when you update the rule group,\u003cbr/\u003eso leave room for your rule group to grow.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCapacity for a stateless rule group\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a stateless rule group, the capacity required is the sum of the capacity\u003cbr/\u003erequirements of the individual rules that you expect to have in the rule\u003cbr/\u003egroup.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo calculate the capacity requirement of a single rule, multiply the capacity\u003cbr/\u003erequirement values of each of the rule\u0026rsquo;s match settings:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A match setting with no criteria specified has a value of 1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A match setting with Any specified has a value of 1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * All other match settings have a value equal to the number of elements\u003cbr/\u003e provided in the setting. For example, a protocol setting [\u0026ldquo;UDP\u0026rdquo;] and a\u003cbr/\u003e source setting [\u0026ldquo;10.0.0.0/24\u0026rdquo;] each have a value of 1. A protocol setting\u003cbr/\u003e [\u0026ldquo;UDP\u0026rdquo;,\u0026ldquo;TCP\u0026rdquo;] has a value of 2. A source setting [\u0026ldquo;10.0.0.0/24\u0026rdquo;,\u0026ldquo;10.0.0.1/24\u0026rdquo;,\u0026ldquo;10.0.0.2/24\u0026rdquo;]\u003cbr/\u003e has a value of 3.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA rule with no criteria specified in any of its match settings has a capacity\u003cbr/\u003erequirement of 1. A rule with protocol setting [\u0026ldquo;UDP\u0026rdquo;,\u0026ldquo;TCP\u0026rdquo;], source setting\u003cbr/\u003e[\u0026ldquo;10.0.0.0/24\u0026rdquo;,\u0026ldquo;10.0.0.1/24\u0026rdquo;,\u0026ldquo;10.0.0.2/24\u0026rdquo;], and a single specification or\u003cbr/\u003eno specification for each of the other match settings has a capacity requirement\u003cbr/\u003eof 6.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCapacity for a stateful rule group\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a stateful rule group, the minimum capacity required is the number of\u003cbr/\u003eindividual rules that you expect to have in the rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edryRun\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether you want Network Firewall to just check the validity of\u003cbr/\u003ethe request, rather than run the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf set to TRUE, Network Firewall checks whether the request can run successfully,\u003cbr/\u003ebut doesn\u0026rsquo;t actually make the requested changes. The call returns the value\u003cbr/\u003ethat the request would return if you ran it with dry run set to FALSE, but\u003cbr/\u003edoesn\u0026rsquo;t make additions or changes to your resources. This option allows you\u003cbr/\u003eto make sure that you have the required permissions to run the request and\u003cbr/\u003ethat your request parameters are valid.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf set to FALSE, Network Firewall makes the requested changes to your resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains settings for encryption of your rule group resources.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that defines the rule group rules.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide either this rule group setting or a Rules setting, but not\u003cbr/\u003eboth.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.referenceSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains a set of IP set references.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.referenceSets.iPSetReferences\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings that are available for use in the rules in the RuleGroup where this\u003cbr/\u003eis defined.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables.iPSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.ruleVariables.portSets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe stateless or stateful rules definitions for use in a single rule group.\u003cbr/\u003eEach rule group requires a single RulesSource. You can use an instance of\u003cbr/\u003ethis for either stateless rules or stateful rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateful inspection criteria for a domain list rule group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor HTTPS traffic, domain filtering is SNI-based. It uses the server name\u003cbr/\u003eindicator extension of the TLS handshake.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, Network Firewall domain list inspection only includes traffic\u003cbr/\u003ecoming from the VPC where you deploy the firewall. To inspect traffic from\u003cbr/\u003eIP addresses outside of the deployment VPC, you set the HOME_NET rule variable\u003cbr/\u003eto include the CIDR range of the deployment VPC plus the other CIDR ranges.\u003cbr/\u003eFor more information, see RuleVariables in this guide and Stateful domain\u003cbr/\u003elist rule groups in Network Firewall (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.generatedRulesType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targetTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targetTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.rulesSourceList.targets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single Suricata rules specification, for use in a stateful rule group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse this option to specify a simple Suricata rule with protocol, source and\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003edestination, ports, direction, and rule options. For information about the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSuricata Rules format, see Rules Format (https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe basic rule criteria for Network Firewall to use to inspect packet headers\u003cbr/\u003ein stateful traffic flow inspection. Traffic flows that match the criteria\u003cbr/\u003eare a match for the corresponding StatefulRule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.destinationPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.direction\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.protocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.source\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].header.sourcePort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditional settings for a stateful rule. This is part of the StatefulRule\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econfiguration.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[].settings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statefulRules.[].ruleOptions.[].settings.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn optional, non-standard action to use for stateless packet handling. You\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan define this in addition to the standard action that you must specify.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou define and name the custom actions that you want to be able to use, and\nthen you reference them by name in your actions settings.\u003c/p\u003e\n\u003cp\u003eYou can use custom actions in the following places:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eIn a rule group\u0026rsquo;s StatelessRulesAndCustomActions specification. The\ncustom actions are available for use by name inside the StatelessRulesAndCustomActions\nwhere you define them. You can use them for your stateless rule actions\nto specify what to do with a packet that matches the rule\u0026rsquo;s match attributes.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIn a FirewallPolicy specification, in StatelessCustomActions. The custom\nactions are available for use inside the policy where you define them.\nYou can use them for the policy\u0026rsquo;s default stateless actions settings to\nspecify what to do with packets that don\u0026rsquo;t match any of the policy\u0026rsquo;s stateless\nrules. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom action to use in stateless rule actions settings. This is used in\u003cbr/\u003eCustomAction. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eStateless inspection criteria that publishes the specified metrics to Amazon\u003cbr/\u003eCloudWatch for the matching packet. This setting defines a CloudWatch dimension\u003cbr/\u003evalue to be published. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe value to use in an Amazon CloudWatch custom metric dimension. This is\nused in the PublishMetrics CustomAction. A CloudWatch custom metric dimension\nis a name/value pair that\u0026rsquo;s part of the identity of a metric.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eNetwork Firewall sets the dimension name to CustomAction and you provide\nthe dimension value.\u003c/p\u003e\n\u003cp\u003eFor more information about CloudWatch custom metric dimensions, see Publishing\nCustom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions)\nin the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html). || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionDefinition.publishMetricAction.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.customActions.[].actionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single stateless rule. This is used in StatelessRulesAndCustomActions. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].priority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe inspection criteria and action for a single stateless rule. Network Firewall\u003cbr/\u003einspects each packet for the specified matching criteria. When a packet matches\u003cbr/\u003ethe criteria, Network Firewall performs the rule\u0026rsquo;s actions on the packet. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.actions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.actions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCriteria for Network Firewall to use to inspect an individual packet in stateless\u003cbr/\u003erule inspection. Each match attributes set can include one or more items\u003cbr/\u003esuch as IP address, CIDR range, port number, protocol, and TCP flags. |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single port range specification. This is used for source and destination\nport ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinationPorts.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single IP address specification. This is used in the MatchAttributes source\nand destination specifications. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.destinations.[].addressDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.protocols\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.protocols.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single port range specification. This is used for source and destination\nport ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sourcePorts.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA single IP address specification. This is used in the MatchAttributes source\nand destination specifications. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.sources.[].addressDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTCP flags and masks to inspect packets for, used in stateless rules MatchAttributes\nsettings. || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].flags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].flags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].masks\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroup.rulesSource.statelessRulesAndCustomActions.statelessRules.[].ruleDefinition.matchAttributes.tcpFlags.[].masks.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruleGroup.statefulRuleOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAdditional options governing how Network Firewall handles the rule group.\u003cbr/\u003eYou can only use these for stateful rule groups. |\n| \u003cstrong\u003eruleGroup.statefulRuleOptions.ruleOrder\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruleGroupName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe descriptive name of the rule group. You can\u0026rsquo;t change the name of a rule\u003cbr/\u003egroup after you create it. |\n| \u003cstrong\u003erules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string containing stateful rule group rules specifications in Suricata\u003cbr/\u003eflat format, with one rule per line. Use this to import your existing Suricata\u003cbr/\u003ecompatible rule groups.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provide either this rules setting or a populated RuleGroup setting,\u003cbr/\u003ebut not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can provide your rule group specification in Suricata flat format through\u003cbr/\u003ethis setting when you create or update your rule group. The call response\u003cbr/\u003ereturns a RuleGroup object that Network Firewall has populated from your\u003cbr/\u003estring. |\n| \u003cstrong\u003esourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains metadata about the rule group that your own\u003cbr/\u003erule group is copied from. You can use the metadata to keep track of updates\u003cbr/\u003emade to the originating rule group. |\n| \u003cstrong\u003esourceMetadata.sourceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esourceMetadata.sourceUpdateToken\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe key:value pairs to associate with the resource. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\npair can be anything you define. Typically, the tag key represents a category\n(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\nthat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\nup to 50 tags to each Amazon Web Services resource. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| **type_**\u003cbr/\u003eRequired | **string**\u003cbr/\u003eIndicates whether the rule group is stateless or stateful. If the rule group\u003cbr/\u003eis stateless, it contains stateless rules. If it is stateful, it contains\u003cbr/\u003estateful rules. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nruleGroupResponse: \n analysisResults:\n - analysisDetail: string\n identifiedRuleIDs:\n - string\n identifiedType: string\n capacity: integer\n consumedCapacity: integer\n description: string\n encryptionConfiguration: \n keyID: string\n type_: string\n lastModifiedTime: string\n numberOfAssociations: integer\n ruleGroupARN: string\n ruleGroupID: string\n ruleGroupName: string\n ruleGroupStatus: string\n snsTopic: string\n sourceMetadata: \n sourceARN: string\n sourceUpdateToken: string\n tags:\n - key: string\n value: string\n type_: string\nupdateToken: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe high-level properties of a rule group. This, along with the RuleGroup,\u003cbr/\u003edefine the rule group. You can retrieve all objects for a rule group by calling\u003cbr/\u003eDescribeRuleGroup.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe analysis result for Network Firewall\u0026rsquo;s stateless rule group analyzer.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEvery time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eon a stateless rule group, Network Firewall analyzes the stateless rule groups\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein your account and identifies the rules that might adversely effect your\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efirewall\u0026rsquo;s functionality. For example, if Network Firewall detects a rule\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat\u0026rsquo;s routing traffic asymmetrically, which impacts the service\u0026rsquo;s ability\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto properly process traffic, the service includes the rule in a list of analysis\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eresults.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[].identifiedRuleIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.analysisResults.[].identifiedRuleIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.capacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.consumedCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.encryptionConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA complex type that contains optional Amazon Web Services Key Management\u003cbr/\u003eService (KMS) encryption settings for your Network Firewall resources. Your\u003cbr/\u003edata is encrypted by default with an Amazon Web Services owned key that Amazon\u003cbr/\u003eWeb Services owns and manages for you. You can use either the Amazon Web\u003cbr/\u003eServices owned key, or provide your own customer managed key. To learn more\u003cbr/\u003eabout KMS encryption of your Network Firewall resources, see Encryption at\u003cbr/\u003erest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)\u003cbr/\u003ein the Network Firewall Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.encryptionConfiguration.keyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**ruleGroupResponse.encryptionConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.lastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.numberOfAssociations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.ruleGroupStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.snsTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eHigh-level information about the managed rule group that your own rule group\u003cbr/\u003eis copied from. You can use the the metadata to track version updates made\u003cbr/\u003eto the originating rule group. You can retrieve all objects for a rule group\u003cbr/\u003eby calling DescribeRuleGroup (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata.sourceARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.sourceMetadata.sourceUpdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key:value pair associated with an Amazon Web Services resource. The key:value\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003epair can be anything you define. Typically, the tag key represents a category\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e(such as \u0026ldquo;environment\u0026rdquo;) and the tag value represents a specific value within\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat category (such as \u0026ldquo;test,\u0026rdquo; \u0026ldquo;development,\u0026rdquo; or \u0026ldquo;production\u0026rdquo;). You can add\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eup to 50 tags to each Amazon Web Services resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruleGroupResponse.tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**ruleGroupResponse.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eupdateToken\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA token used for optimistic locking. Network Firewall returns a token to\u003cbr/\u003eyour requests that access the rule group. The token marks the state of the\u003cbr/\u003erule group resource at the time of the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo make changes to the rule group, you provide the token in your request.\u003cbr/\u003eNetwork Firewall uses the token to ensure that the rule group hasn\u0026rsquo;t changed\u003cbr/\u003esince you last retrieved it. If it has changed, the operation fails with\u003cbr/\u003ean InvalidTokenException. If this happens, retrieve the rule group again\u003cbr/\u003eto get a current copy of it with a current token. Reapply your changes as\u003cbr/\u003eneeded, then try the operation again using the new token.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:162,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/rulegroupsnamespace/",title:"RuleGroupsNamespace",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#RuleGroupsNamespace"\u003eprometheusservice-controller/apis/v1alpha1#RuleGroupsNamespace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupsNamespace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eRuleGroupsNamespaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroupsnamespaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003erulegroupsnamespace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econfiguration: string\nname: string\ntags: {}\nworkspaceID: string\nworkspaceRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfiguration\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe rule groups namespace name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional, user-provided tags for this rule groups namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the workspace in which to create the rule group namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: \n statusCode: string\n statusReason: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of rule groups namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eState of a namespace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:163,href:"https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalabletarget/",title:"ScalableTarget",description:null,content:'\u003cp\u003e\u003ccode\u003eapplicationautoscaling.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/applicationautoscaling-controller/apis/v1alpha1#ScalableTarget"\u003eapplicationautoscaling-controller/apis/v1alpha1#ScalableTarget\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalableTarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalableTargetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalabletargets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalabletarget\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a scalable target.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003emaxCapacity: integer\nminCapacity: integer\nresourceID: string\nroleARN: string\nscalableDimension: string\nserviceNamespace: string\nsuspendedState: \n dynamicScalingInSuspended: boolean\n dynamicScalingOutSuspended: boolean\n scheduledScalingSuspended: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum value that you plan to scale out to. When a scaling policy is\u003cbr/\u003ein effect, Application Auto Scaling can scale out (expand) as needed to the\u003cbr/\u003emaximum capacity limit in response to changing demand. This property is required\u003cbr/\u003ewhen registering a new scalable target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlthough you can specify a large maximum capacity, note that service quotas\u003cbr/\u003emay impose lower limits. Each service has its own default quotas for the\u003cbr/\u003emaximum capacity of the resource. If you want to specify a higher limit,\u003cbr/\u003eyou can request an increase. For more information, consult the documentation\u003cbr/\u003efor that service. For information about the default quotas for each service,\u003cbr/\u003esee Service Endpoints and Quotas (https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html)\u003cbr/\u003ein the Amazon Web Services General Reference.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminCapacity\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe minimum value that you plan to scale in to. When a scaling policy is\u003cbr/\u003ein effect, Application Auto Scaling can scale in (contract) as needed to\u003cbr/\u003ethe minimum capacity limit in response to changing demand. This property\u003cbr/\u003eis required when registering a new scalable target.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor certain resources, the minimum value allowed is 0. This includes Lambda\u003cbr/\u003eprovisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR\u003cbr/\u003eclusters, and custom resources. For all other resources, the minimum value\u003cbr/\u003eallowed is 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the resource that is associated with the scalable target.\u003cbr/\u003eThis string consists of the resource type and unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ECS service - The resource type is service and the unique identifier\u003cbr/\u003e is the cluster name and service name. Example: service/default/sample-webapp.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Spot Fleet - The resource type is spot-fleet-request and the unique\u003cbr/\u003e identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * EMR cluster - The resource type is instancegroup and the unique identifier\u003cbr/\u003e is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AppStream 2.0 fleet - The resource type is fleet and the unique identifier\u003cbr/\u003e is the fleet name. Example: fleet/sample-fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: table/my-table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB global secondary index - The resource type is index and the\u003cbr/\u003e unique identifier is the index name. Example: table/my-table/index/my-table-index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora DB cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:my-db-cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SageMaker endpoint variant - The resource type is variant and the unique\u003cbr/\u003e identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Custom resources are not supported with a resource type. This parameter\u003cbr/\u003e must specify the OutputValue from the CloudFormation template stack used\u003cbr/\u003e to access the resources. The unique identifier is defined by the service\u003cbr/\u003e provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend document classification endpoint - The resource type\u003cbr/\u003e and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend entity recognizer endpoint - The resource type and\u003cbr/\u003e unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Lambda provisioned concurrency - The resource type is function and the\u003cbr/\u003e unique identifier is the function name with a function version or alias\u003cbr/\u003e name suffix that is not $LATEST. Example: function:my-function:prod or\u003cbr/\u003e function:my-function:1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Keyspaces table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: keyspace/mykeyspace/table/mytable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MSK cluster - The resource type and unique identifier are specified\u003cbr/\u003e using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ElastiCache replication group - The resource type is replication-group\u003cbr/\u003e and the unique identifier is the replication group name. Example: replication-group/mycluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Neptune cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:mycluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis parameter is required for services that do not support service-linked\u003cbr/\u003eroles (such as Amazon EMR), and it must specify the ARN of an IAM role that\u003cbr/\u003eallows Application Auto Scaling to modify the scalable target on your behalf.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service supports service-linked roles, Application Auto Scaling uses\u003cbr/\u003ea service-linked role, which it creates if it does not yet exist. For more\u003cbr/\u003einformation, see Application Auto Scaling IAM roles (https://docs.aws.amazon.com/autoscaling/application/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-roles).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalableDimension\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scalable dimension associated with the scalable target. This string consists\u003cbr/\u003eof the service namespace, resource type, and scaling property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ecs:service:DesiredCount - The desired task count of an ECS service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticmapreduce:instancegroup:InstanceCount - The instance count of\u003cbr/\u003e an EMR Instance Group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot\u003cbr/\u003e Fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream\u003cbr/\u003e 2.0 fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora\u003cbr/\u003e DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible\u003cbr/\u003e edition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances\u003cbr/\u003e for an SageMaker model endpoint variant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-resource:ResourceType:Property - The scalable dimension for a\u003cbr/\u003e custom resource provided by your own application or service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The\u003cbr/\u003e number of inference units for an Amazon Comprehend document classification\u003cbr/\u003e endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number\u003cbr/\u003e of inference units for an Amazon Comprehend entity recognizer endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda:function:ProvisionedConcurrency - The provisioned concurrency\u003cbr/\u003e for a Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:WriteCapacityUnits - The provisioned write capacity\u003cbr/\u003e for an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)\u003cbr/\u003e for brokers in an Amazon MSK cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:NodeGroups - The number of node groups\u003cbr/\u003e for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:Replicas - The number of replicas per\u003cbr/\u003e node group for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * neptune:cluster:ReadReplicaCount - The count of read replicas in an\u003cbr/\u003e Amazon Neptune DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceNamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace of the Amazon Web Services service that provides the resource.\u003cbr/\u003eFor a resource provided by your own application or service, use custom-resource\u003cbr/\u003einstead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn embedded object that contains attributes and attribute values that are\u003cbr/\u003eused to suspend and resume automatic scaling. Setting the value of an attribute\u003cbr/\u003eto true suspends the specified scaling activities. Setting it to false (default)\u003cbr/\u003eresumes the specified scaling activities.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSuspension Outcomes\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For DynamicScalingInSuspended, while a suspension is in effect, all\u003cbr/\u003e scale-in activities that are triggered by a scaling policy are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For DynamicScalingOutSuspended, while a suspension is in effect, all\u003cbr/\u003e scale-out activities that are triggered by a scaling policy are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For ScheduledScalingSuspended, while a suspension is in effect, all\u003cbr/\u003e scaling activities that involve scheduled actions are suspended.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Suspending and resuming scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-suspend-resume-scaling.html)\u003cbr/\u003ein the Application Auto Scaling User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.dynamicScalingInSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.dynamicScalingOutSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esuspendedState.scheduledScalingSuspended\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scalable target was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scalable target was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:164,href:"https://aws-controllers-k8s.github.io/community/reference/applicationautoscaling/v1alpha1/scalingpolicy/",title:"ScalingPolicy",description:null,content:'\u003cp\u003e\u003ccode\u003eapplicationautoscaling.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/applicationautoscaling-controller/apis/v1alpha1#ScalingPolicy"\u003eapplicationautoscaling-controller/apis/v1alpha1#ScalingPolicy\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalingPolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eScalingPolicyList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalingpolicies\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003escalingpolicy\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a scaling policy to use with Application Auto Scaling.\u003c/p\u003e\n\u003cp\u003eFor more information about configuring scaling policies for a specific service,\nsee Getting started with Application Auto Scaling (https://docs.aws.amazon.com/autoscaling/application/userguide/getting-started.html)\nin the Application Auto Scaling User Guide.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003epolicyName: string\npolicyType: string\nresourceID: string\nscalableDimension: string\nserviceNamespace: string\nstepScalingPolicyConfiguration: \n adjustmentType: string\n cooldown: integer\n metricAggregationType: string\n minAdjustmentMagnitude: integer\n stepAdjustments:\n - metricIntervalLowerBound: number\n metricIntervalUpperBound: number\n scalingAdjustment: integer\ntargetTrackingScalingPolicyConfiguration: \n customizedMetricSpecification: \n dimensions:\n - name: string\n value: string\n metricName: string\n namespace: string\n statistic: string\n unit: string\n disableScaleIn: boolean\n predefinedMetricSpecification: \n predefinedMetricType: string\n resourceLabel: string\n scaleInCooldown: integer\n scaleOutCooldown: integer\n targetValue: number\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe policy type. This parameter is required if you are creating a scaling\u003cbr/\u003epolicy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following policy types are supported:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTargetTrackingScaling—Not supported for Amazon EMR\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon\u003cbr/\u003eKeyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Target tracking scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html)\u003cbr/\u003eand Step scaling policies (https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html)\u003cbr/\u003ein the Application Auto Scaling User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of the resource associated with the scaling policy. This string\u003cbr/\u003econsists of the resource type and unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ECS service - The resource type is service and the unique identifier\u003cbr/\u003e is the cluster name and service name. Example: service/default/sample-webapp.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Spot Fleet - The resource type is spot-fleet-request and the unique\u003cbr/\u003e identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * EMR cluster - The resource type is instancegroup and the unique identifier\u003cbr/\u003e is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AppStream 2.0 fleet - The resource type is fleet and the unique identifier\u003cbr/\u003e is the fleet name. Example: fleet/sample-fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: table/my-table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DynamoDB global secondary index - The resource type is index and the\u003cbr/\u003e unique identifier is the index name. Example: table/my-table/index/my-table-index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Aurora DB cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:my-db-cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * SageMaker endpoint variant - The resource type is variant and the unique\u003cbr/\u003e identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Custom resources are not supported with a resource type. This parameter\u003cbr/\u003e must specify the OutputValue from the CloudFormation template stack used\u003cbr/\u003e to access the resources. The unique identifier is defined by the service\u003cbr/\u003e provider. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend document classification endpoint - The resource type\u003cbr/\u003e and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Comprehend entity recognizer endpoint - The resource type and\u003cbr/\u003e unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Lambda provisioned concurrency - The resource type is function and the\u003cbr/\u003e unique identifier is the function name with a function version or alias\u003cbr/\u003e name suffix that is not $LATEST. Example: function:my-function:prod or\u003cbr/\u003e function:my-function:1.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Keyspaces table - The resource type is table and the unique identifier\u003cbr/\u003e is the table name. Example: keyspace/mykeyspace/table/mytable.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon MSK cluster - The resource type and unique identifier are specified\u003cbr/\u003e using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ElastiCache replication group - The resource type is replication-group\u003cbr/\u003e and the unique identifier is the replication group name. Example: replication-group/mycluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Neptune cluster - The resource type is cluster and the unique identifier\u003cbr/\u003e is the cluster name. Example: cluster:mycluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003escalableDimension\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scalable dimension. This string consists of the service namespace, resource\u003cbr/\u003etype, and scaling property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ecs:service:DesiredCount - The desired task count of an ECS service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticmapreduce:instancegroup:InstanceCount - The instance count of\u003cbr/\u003e an EMR Instance Group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot\u003cbr/\u003e Fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * appstream:fleet:DesiredCapacity - The desired capacity of an AppStream\u003cbr/\u003e 2.0 fleet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:table:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * dynamodb:index:WriteCapacityUnits - The provisioned write capacity for\u003cbr/\u003e a DynamoDB global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora\u003cbr/\u003e DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible\u003cbr/\u003e edition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sagemaker:variant:DesiredInstanceCount - The number of EC2 instances\u003cbr/\u003e for an SageMaker model endpoint variant.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * custom-resource:ResourceType:Property - The scalable dimension for a\u003cbr/\u003e custom resource provided by your own application or service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:document-classifier-endpoint:DesiredInferenceUnits - The\u003cbr/\u003e number of inference units for an Amazon Comprehend document classification\u003cbr/\u003e endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number\u003cbr/\u003e of inference units for an Amazon Comprehend entity recognizer endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda:function:ProvisionedConcurrency - The provisioned concurrency\u003cbr/\u003e for a Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:ReadCapacityUnits - The provisioned read capacity for\u003cbr/\u003e an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * cassandra:table:WriteCapacityUnits - The provisioned write capacity\u003cbr/\u003e for an Amazon Keyspaces table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB)\u003cbr/\u003e for brokers in an Amazon MSK cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:NodeGroups - The number of node groups\u003cbr/\u003e for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * elasticache:replication-group:Replicas - The number of replicas per\u003cbr/\u003e node group for an Amazon ElastiCache replication group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * neptune:cluster:ReadReplicaCount - The count of read replicas in an\u003cbr/\u003e Amazon Neptune DB cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceNamespace\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe namespace of the Amazon Web Services service that provides the resource.\u003cbr/\u003eFor a resource provided by your own application or service, use custom-resource\u003cbr/\u003einstead.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA step scaling policy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required if you are creating a policy and the policy type\u003cbr/\u003eis StepScaling.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.adjustmentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.cooldown\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.metricAggregationType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.minAdjustmentMagnitude\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a step adjustment for a StepScalingPolicyConfiguration (https://docs.aws.amazon.com/autoscaling/application/APIReference/API_StepScalingPolicyConfiguration.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eDescribes an adjustment based on the difference between the value of the\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eaggregated CloudWatch metric and the breach threshold that you\u0026rsquo;ve defined\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efor the alarm.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eFor the following examples, suppose that you have an alarm with a breach\nthreshold of 50:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eTo trigger the adjustment when the metric is greater than or equal to\n50 and less than 60, specify a lower bound of 0 and an upper bound of\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="10"\u003e\n\u003cli\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cul\u003e\n\u003cli\u003eTo trigger the adjustment when the metric is greater than 40 and less\nthan or equal to 50, specify a lower bound of -10 and an upper bound of\u003c/li\u003e\n\u003c/ul\u003e\n\u003col start="0"\u003e\n\u003cli\u003e\u003c/li\u003e\n\u003c/ol\u003e\n\u003cp\u003eThere are a few rules for the step adjustments for your step policy:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe ranges of your step adjustments can\u0026rsquo;t overlap or have a gap.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAt most one step adjustment can have a null lower bound. If one step\nadjustment has a negative lower bound, then there must be a step adjustment\nwith a null lower bound.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eAt most one step adjustment can have a null upper bound. If one step\nadjustment has a positive upper bound, then there must be a step adjustment\nwith a null upper bound.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe upper and lower bound can\u0026rsquo;t be null in the same step adjustment. || \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalLowerBound\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].metricIntervalUpperBound\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estepScalingPolicyConfiguration.stepAdjustments.[].scalingAdjustment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA target tracking scaling policy. Includes support for predefined or customized\u003cbr/\u003emetrics.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required if you are creating a policy and the policy type\u003cbr/\u003eis TargetTrackingScaling. |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CloudWatch metric of your choosing for a target tracking scaling\u003cbr/\u003epolicy to use with Application Auto Scaling.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about the available metrics for a service, see Amazon Web\u003cbr/\u003eServices Services That Publish CloudWatch Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)\u003cbr/\u003ein the Amazon CloudWatch User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create your customized metric specification:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Add values for each required parameter from CloudWatch. You can use\u003cbr/\u003e an existing metric, or a new metric that you create. To use your own metric,\u003cbr/\u003e you must first publish the metric to CloudWatch. For more information,\u003cbr/\u003e see Publish Custom Metrics (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html)\u003cbr/\u003e in the Amazon CloudWatch User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Choose a metric that changes proportionally with capacity. The value\u003cbr/\u003e of the metric should increase or decrease in inverse proportion to the\u003cbr/\u003e number of capacity units. That is, the value of the metric should decrease\u003cbr/\u003e when capacity increases, and increase when capacity decreases.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about CloudWatch, see Amazon CloudWatch Concepts (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html). |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the dimension names and values associated with a metric. || \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.dimensions.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.metricName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.statistic\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.customizedMetricSpecification.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.disableScaleIn\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a predefined metric for a target tracking scaling policy to use\u003cbr/\u003ewith Application Auto Scaling.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnly the Amazon Web Services that you\u0026rsquo;re using send metrics to Amazon CloudWatch.\u003cbr/\u003eTo determine whether a desired metric already exists by looking up its namespace\u003cbr/\u003eand dimension using the CloudWatch metrics dashboard in the console, follow\u003cbr/\u003ethe procedure in Building dashboards with CloudWatch (https://docs.aws.amazon.com/autoscaling/application/userguide/monitoring-cloudwatch.html)\u003cbr/\u003ein the Application Auto Scaling User Guide. |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.predefinedMetricType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.predefinedMetricSpecification.resourceLabel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.scaleInCooldown\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.scaleOutCooldown\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etargetTrackingScalingPolicyConfiguration.targetValue\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nalarms:\n- alarmARN: string\n alarmName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nlastModifiedTime: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe CloudWatch alarms created for the target tracking scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a CloudWatch alarm associated with a scaling policy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealarms.[].alarmName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scaling policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for when the scaling policy was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:165,href:"https://aws-controllers-k8s.github.io/community/reference/secretsmanager/v1alpha1/secret/",title:"Secret",description:null,content:'\u003cp\u003e\u003ccode\u003esecretsmanager.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/secretsmanager-controller/apis/v1alpha1#Secret"\u003esecretsmanager-controller/apis/v1alpha1#Secret\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecret\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecretList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecrets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecret\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nforceOverwriteReplicaSecret: boolean\nkmsKeyID: string\nname: string\nreplicaRegions:\n- kmsKeyID: string\n region: string\nsecretString: \n key: string\n name: string\n namespace: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe description of the secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eforceOverwriteReplicaSecret\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to overwrite a secret with the same name in the destination\u003cbr/\u003eRegion. By default, secrets aren\u0026rsquo;t overwritten.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt\u003cbr/\u003ethe secret value in the secret. An alias is always prefixed by alias/, for\u003cbr/\u003eexample alias/aws/secretsmanager. For more information, see About aliases\u003cbr/\u003e(https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a KMS key in a different account, use the key ARN or the alias ARN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you don\u0026rsquo;t specify this value, then Secrets Manager uses the key aws/secretsmanager.\u003cbr/\u003eIf that key doesn\u0026rsquo;t yet exist, then Secrets Manager creates it for you automatically\u003cbr/\u003ethe first time it encrypts the secret value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the secret is in a different Amazon Web Services account from the credentials\u003cbr/\u003ecalling the API, then you can\u0026rsquo;t use aws/secretsmanager to encrypt the secret,\u003cbr/\u003eand you must create and use a customer managed KMS key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the new secret.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe secret name can contain ASCII letters, numbers, and the following characters:\u003cbr/\u003e/_+=.@-\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDo not end your secret name with a hyphen followed by six characters. If\u003cbr/\u003eyou do so, you risk confusion and unexpected results when searching for a\u003cbr/\u003esecret by partial ARN. Secrets Manager automatically adds a hyphen and six\u003cbr/\u003erandom characters after the secret name at the end of the ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of Regions and KMS keys to replicate secrets.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom type that specifies a Region and the KmsKeyId for a replica secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicaRegions.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe text data to encrypt and store in this new version of the secret. We\u003cbr/\u003erecommend you use a JSON structure of key/value pairs for your secret value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEither SecretString or SecretBinary must have a value, but not both.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you create a secret by using the Secrets Manager console then Secrets\u003cbr/\u003eManager puts the protected secret text in only the SecretString parameter.\u003cbr/\u003eThe Secrets Manager console stores the information as a JSON structure of\u003cbr/\u003ekey/value pairs that a Lambda rotation function can parse.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.key\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eKey is the key within the secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecretString.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to attach to the secret. Each tag is a key and value pair\u003cbr/\u003eof strings in a JSON text string, for example:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e[{\u0026ldquo;Key\u0026rdquo;:\u0026ldquo;CostCenter\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026ldquo;12345\u0026rdquo;},{\u0026ldquo;Key\u0026rdquo;:\u0026ldquo;environment\u0026rdquo;,\u0026ldquo;Value\u0026rdquo;:\u0026ldquo;production\u0026rdquo;}]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSecrets Manager tag key names are case sensitive. A tag with the key \u0026ldquo;ABC\u0026rdquo;\u003cbr/\u003eis a different tag from one with key \u0026ldquo;abc\u0026rdquo;.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you check tags in permissions policies as part of your security strategy,\u003cbr/\u003ethen adding or removing a tag can change permissions. If the completion of\u003cbr/\u003ethis operation would result in you losing your permissions for this secret,\u003cbr/\u003ethen Secrets Manager blocks the operation and returns an Access Denied error.\u003cbr/\u003eFor more information, see Control access to secrets using tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac)\u003cbr/\u003eand Limit access to identities with tags that match secrets\' tags (https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor information about how to format a JSON parameter for the various command\u003cbr/\u003eline tool environments, see Using JSON for Parameters (https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json).\u003cbr/\u003eIf your command-line tool or SDK requires quotation marks around the parameter,\u003cbr/\u003eyou should use single quotes to avoid confusion with the double quotes required\u003cbr/\u003ein the JSON text.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tag quotas and naming restrictions, see Service quotas for Tagging (https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas)\u003cbr/\u003ein the Amazon Web Services General Reference guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that contains information about a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nreplicationStatus:\n- kmsKeyID: string\n lastAccessedDate: string\n region: string\n status: string\n statusMessage: string\nversionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the replicas of this secret and their status:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed, which indicates that the replica was not created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InProgress, which indicates that Secrets Manager is in the process of\u003cbr/\u003e creating the replica.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InSync, which indicates that the replica was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA replication object consisting of a RegionReplicationStatus object and includes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea Region, KMSKeyId, status, and status message.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].lastAccessedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationStatus.[].statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe unique identifier associated with the version of the new secret.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:166,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/securitygroup/",title:"SecurityGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#SecurityGroup"\u003eec2-controller/apis/v1alpha1#SecurityGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecurityGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSecurityGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecuritygroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esecuritygroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a security group.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\negressRules:\n- fromPort: integer\n ipProtocol: string\n ipRanges:\n - cidrIP: string\n description: string\n ipv6Ranges:\n - cidrIPv6: string\n description: string\n prefixListIDs:\n - description: string\n prefixListID: string\n toPort: integer\n userIDGroupPairs:\n - description: string\n groupID: string\n groupName: string\n peeringStatus: string\n userID: string\n vpcID: string\n vpcPeeringConnectionID: string\ningressRules:\n- fromPort: integer\n ipProtocol: string\n ipRanges:\n - cidrIP: string\n description: string\n ipv6Ranges:\n - cidrIPv6: string\n description: string\n prefixListIDs:\n - description: string\n prefixListID: string\n toPort: integer\n userIDGroupPairs:\n - description: string\n groupID: string\n groupName: string\n peeringStatus: string\n userID: string\n vpcID: string\n vpcPeeringConnectionID: string\nname: string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the security group. This is informational only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Up to 255 characters in length\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-Classic: ASCII characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a set of permissions for a security group rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipRanges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC only] Describes an IPv6 range.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].ipv6Ranges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a prefix list ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].prefixListIDs.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].userIDGroupPairs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eegressRules.[].userIDGroupPairs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group and Amazon Web Services account ID pair.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\nfrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\nto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\nin the Amazon Elastic Compute Cloud User Guide. || \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].groupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].peeringStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].userID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eegressRules.[].userIDGroupPairs.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a set of permissions for a security group rule. || \u003cstrong\u003eingressRules.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 range. || \u003cstrong\u003eingressRules.[].ipRanges.[].cidrIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipRanges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e[EC2-VPC only] Describes an IPv6 range. || \u003cstrong\u003eingressRules.[].ipv6Ranges.[].cidrIPv6\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].ipv6Ranges.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a prefix list ID. || \u003cstrong\u003eingressRules.[].prefixListIDs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].prefixListIDs.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group and Amazon Web Services account ID pair.\u003c/p\u003e\n\u003cp\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\nfrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\nto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\nin the Amazon Elastic Compute Cloud User Guide. || \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].description\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].groupID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].peeringStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].userID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].vpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eingressRules.[].userIDGroupPairs.[].vpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the security group.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Up to 255 characters in length. Cannot start with sg-.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-Classic: ASCII characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$* |\n| **tags**\u003cbr/\u003eOptional | **array**\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| **tags.[]**\u003cbr/\u003eRequired | **object**\u003cbr/\u003eDescribes a tag. || **tags.[].key**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **tags.[].value**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\n| **vpcID**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e[EC2-VPC] The ID of the VPC. Required for EC2-VPC. |\n| **vpcRef**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| **vpcRef.from**\u003cbr/\u003eOptional | **object**\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| **vpcRef.from.name**\u003cbr/\u003eOptional | **string**\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\nrules:\n- cidrIPv4: string\n cidrIPv6: string\n description: string\n fromPort: integer\n ipProtocol: string\n isEgress: boolean\n prefixListID: string\n securityGroupRuleID: string\n tags:\n - key: string\n value: string\n toPort: integer\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the security group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about security group rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group rule.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].cidrIPv6\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].fromPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].ipProtocol\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].isEgress\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].prefixListID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].securityGroupRuleID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erules.[].toPort\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:167,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/service/",title:"Service",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#Service"\u003eecs-controller/apis/v1alpha1#Service\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eService\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eServiceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eservices\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eservice\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDetails on a service within a cluster.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacityProviderStrategy:\n- base: integer\n capacityProvider: string\n weight: integer\ncluster: string\nclusterRef: \n from: \n name: string\ndeploymentConfiguration: \n alarms: \n alarmNames:\n - string\n enable: boolean\n rollback: boolean\n deploymentCircuitBreaker: \n enable: boolean\n rollback: boolean\n maximumPercent: integer\n minimumHealthyPercent: integer\ndeploymentController: \n type: string\ndesiredCount: integer\nenableECSManagedTags: boolean\nenableExecuteCommand: boolean\nhealthCheckGracePeriodSeconds: integer\nlaunchType: string\nloadBalancers:\n- containerName: string\n containerPort: integer\n loadBalancerName: string\n targetGroupARN: string\nname: string\nnetworkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\nplacementConstraints:\n- expression: string\n type: string\nplacementStrategy:\n- field: string\n type: string\nplatformVersion: string\npropagateTags: string\nrole: string\nroleRef: \n from: \n name: string\nschedulingStrategy: string\nserviceConnectConfiguration: \n enabled: boolean\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n namespace: string\n services:\n clientAliases:\n - dnsName: string\n port: integer\n discoveryName: string\n ingressPortOverride: integer\n portName: string\n timeout: \n idleTimeoutSeconds: integer\n perRequestTimeoutSeconds: integer\n tls: \n issuerCertificateAuthority: \n awsPCAAuthorityARN: string\n kmsKey: string\n roleARN: string\nserviceRegistries:\n- containerName: string\n containerPort: integer\n port: integer\n registryARN: string\ntags:\n- key: string\n value: string\ntaskDefinition: string\ntaskDefinitionRef: \n from: \n name: string\nvolumeConfigurations:\n managedEBSVolume: \n encrypted: boolean\n filesystemType: string\n iops: integer\n kmsKeyID: string\n roleARN: string\n sizeInGiB: integer\n snapshotID: string\n tagSpecifications:\n - propagateTags: string\n resourceType: string\n tags:\n - key: string\n value: string\n throughput: integer\n volumeType: string\n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe capacity provider strategy to use for the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a capacityProviderStrategy is specified, the launchType parameter must\u003cbr/\u003ebe omitted. If no capacityProviderStrategy or launchType is specified, the\u003cbr/\u003edefaultCapacityProviderStrategy for the cluster is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA capacity provider strategy may contain a maximum of 6 capacity providers.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003ecapacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecapacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecapacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecluster\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe short name or full Amazon Resource Name (ARN) of the cluster that you\u003cbr/\u003erun your service on. If you do not specify a cluster, the default cluster\u003cbr/\u003eis assumed. |\n| \u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional deployment parameters that control how many tasks run during the\u003cbr/\u003edeployment and the ordering of stopping and starting tasks. |\n| \u003cstrong\u003edeploymentConfiguration.alarms\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOne of the methods which provide a way for you to quickly identify when a\u003cbr/\u003edeployment has failed, and then to optionally roll back the failure to the\u003cbr/\u003elast working deployment.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen the alarms are generated, Amazon ECS sets the service deployment to\u003cbr/\u003efailed. Set the rollback parameter to have Amazon ECS to roll back your service\u003cbr/\u003eto the last completed deployment after a failure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can only use the DeploymentAlarms method to detect failures when the\u003cbr/\u003eDeploymentController is set to ECS (rolling update).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide . |\n| \u003cstrong\u003edeploymentConfiguration.alarms.alarmNames\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.alarms.alarmNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeploymentConfiguration.alarms.enable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.alarms.rollback\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment circuit breaker can only be used for services using the rolling\u003cbr/\u003eupdate (ECS) deployment type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe deployment circuit breaker determines whether a service deployment will\u003cbr/\u003efail if the service can\u0026rsquo;t reach a steady state. If it is turned on, a service\u003cbr/\u003edeployment will transition to a failed state and stop launching new tasks.\u003cbr/\u003eYou can also configure Amazon ECS to roll back your service to the last completed\u003cbr/\u003edeployment after a failure. For more information, see Rolling update (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about API failure reasons, see API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker.enable\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.deploymentCircuitBreaker.rollback\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.maximumPercent\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentConfiguration.minimumHealthyPercent\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeploymentController\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe deployment controller to use for the service. If no deployment controller\u003cbr/\u003eis specified, the default value of ECS is used. |\n| \u003cstrong\u003edeploymentController.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edesiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of instantiations of the specified task definition to place and\u003cbr/\u003ekeep running in your service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis is required if schedulingStrategy is REPLICA or isn\u0026rsquo;t specified. If\u003cbr/\u003eschedulingStrategy is DAEMON then this isn\u0026rsquo;t required. |\n| \u003cstrong\u003eenableECSManagedTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to turn on Amazon ECS managed tags for the tasks within\u003cbr/\u003ethe service. For more information, see Tagging your Amazon ECS resources\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you use Amazon ECS managed tags, you need to set the propagateTags request\u003cbr/\u003eparameter. |\n| \u003cstrong\u003eenableExecuteCommand\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eDetermines whether the execute command functionality is turned on for the\u003cbr/\u003eservice. If true, this enables execute command functionality on all containers\u003cbr/\u003ein the service tasks. |\n| \u003cstrong\u003ehealthCheckGracePeriodSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe period of time, in seconds, that the Amazon ECS service scheduler ignores\u003cbr/\u003eunhealthy Elastic Load Balancing target health checks after a task has first\u003cbr/\u003estarted. This is only used when your service is configured to use a load\u003cbr/\u003ebalancer. If your service has a load balancer defined and you don\u0026rsquo;t specify\u003cbr/\u003ea health check grace period value, the default value of 0 is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you do not use an Elastic Load Balancing, we recommend that you use the\u003cbr/\u003estartPeriod in the task definition health check parameters. For more information,\u003cbr/\u003esee Health check (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your service\u0026rsquo;s tasks take a while to start and respond to Elastic Load\u003cbr/\u003eBalancing health checks, you can specify a health check grace period of up\u003cbr/\u003eto 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS\u003cbr/\u003eservice scheduler ignores health check status. This grace period can prevent\u003cbr/\u003ethe service scheduler from marking tasks as unhealthy and stopping them before\u003cbr/\u003ethey have time to come up. |\n| \u003cstrong\u003elaunchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe infrastructure that you run your service on. For more information, see\u003cbr/\u003eAmazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFargate Spot infrastructure is available for use but a capacity provider\u003cbr/\u003estrategy must be used. For more information, see Fargate capacity providers\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-capacity-providers.html)\u003cbr/\u003ein the Amazon ECS User Guide for Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe EC2 launch type runs your tasks on Amazon EC2 instances registered to\u003cbr/\u003eyour cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe EXTERNAL launch type runs your tasks on your on-premises server or virtual\u003cbr/\u003emachine (VM) capacity registered to your cluster.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA service can use either a launch type or a capacity provider strategy. If\u003cbr/\u003ea launchType is specified, the capacityProviderStrategy parameter must be\u003cbr/\u003eomitted. |\n| \u003cstrong\u003eloadBalancers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA load balancer object representing the load balancers to use with your service.\u003cbr/\u003eFor more information, see Service load balancing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service uses the rolling update (ECS) deployment controller and using\u003cbr/\u003eeither an Application Load Balancer or Network Load Balancer, you must specify\u003cbr/\u003eone or more target group ARNs to attach to the service. The service-linked\u003cbr/\u003erole is required for services that use multiple target groups. For more information,\u003cbr/\u003esee Using service-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the service uses the CODE_DEPLOY deployment controller, the service is\u003cbr/\u003erequired to use either an Application Load Balancer or Network Load Balancer.\u003cbr/\u003eWhen creating an CodeDeploy deployment group, you specify two target groups\u003cbr/\u003e(referred to as a targetGroupPair). During a deployment, CodeDeploy determines\u003cbr/\u003ewhich task set in your service has the status PRIMARY, and it associates\u003cbr/\u003eone target group with it. Then, it also associates the other target group\u003cbr/\u003ewith the replacement task set. The load balancer can also have up to two\u003cbr/\u003elisteners: a required listener for production traffic and an optional listener\u003cbr/\u003ethat you can use to perform validation tests with Lambda functions before\u003cbr/\u003erouting production traffic to it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you use the CODE_DEPLOY deployment controller, these values can be changed\u003cbr/\u003ewhen updating the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Application Load Balancers and Network Load Balancers, this object must\u003cbr/\u003econtain the load balancer target group ARN, the container name, and the container\u003cbr/\u003eport to access from the load balancer. The container name must be as it appears\u003cbr/\u003ein a container definition. The load balancer name parameter must be omitted.\u003cbr/\u003eWhen a task from this service is placed on a container instance, the container\u003cbr/\u003einstance and port combination is registered as a target in the target group\u003cbr/\u003ethat\u0026rsquo;s specified here.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Classic Load Balancers, this object must contain the load balancer name,\u003cbr/\u003ethe container name , and the container port to access from the load balancer.\u003cbr/\u003eThe container name must be as it appears in a container definition. The target\u003cbr/\u003egroup ARN parameter must be omitted. When a task from this service is placed\u003cbr/\u003eon a container instance, the container instance is registered with the load\u003cbr/\u003ebalancer that\u0026rsquo;s specified here.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eServices with tasks that use the awsvpc network mode (for example, those\u003cbr/\u003ewith the Fargate launch type) only support Application Load Balancers and\u003cbr/\u003eNetwork Load Balancers. Classic Load Balancers aren\u0026rsquo;t supported. Also, when\u003cbr/\u003eyou create any target groups for these services, you must choose ip as the\u003cbr/\u003etarget type, not instance. This is because tasks that use the awsvpc network\u003cbr/\u003emode are associated with an elastic network interface, not an Amazon EC2\u003cbr/\u003einstance. |\n| \u003cstrong\u003eloadBalancers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe load balancer configuration to use with a service or task set.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove a load balancer configuration, Amazon ECS\nstarts a new deployment with the updated Elastic Load Balancing configuration.\nThis causes tasks to register to and deregister from load balancers.\u003c/p\u003e\n\u003cp\u003eWe recommend that you verify this on a test environment before you update\nthe Elastic Load Balancing configuration.\u003c/p\u003e\n\u003cp\u003eA service-linked role is required for services that use multiple target groups.\nFor more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eloadBalancers.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].loadBalancerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eloadBalancers.[].targetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of your service. Up to 255 letters (uppercase and lowercase), numbers,\u003cbr/\u003eunderscores, and hyphens are allowed. Service names must be unique within\u003cbr/\u003ea cluster, but you can have similarly named services in multiple clusters\u003cbr/\u003ewithin a Region or across multiple Regions. |\n| \u003cstrong\u003enetworkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for the service. This parameter is required for\u003cbr/\u003etask definitions that use the awsvpc network mode to receive their own elastic\u003cbr/\u003enetwork interface, and it isn\u0026rsquo;t supported for other network modes. For more\u003cbr/\u003einformation, see Task networking (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003enetworkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eplacementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of placement constraint objects to use for tasks in your service.\u003cbr/\u003eYou can specify a maximum of 10 constraints for each task. This limit includes\u003cbr/\u003econstraints in the task definition and those specified at runtime. |\n| \u003cstrong\u003eplacementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a constraint on task placement. For more information,\nsee Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eIf you\u0026rsquo;re using the Fargate launch type, task placement constraints aren\u0026rsquo;t\nsupported. || \u003cstrong\u003eplacementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementConstraints.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe placement strategy objects to use for tasks in your service. You can\u003cbr/\u003especify a maximum of 5 strategy rules for each service. |\n| \u003cstrong\u003eplacementStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe task placement strategy for a task or service. For more information,\nsee Task placement strategies (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eplacementStrategy.[].field\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementStrategy.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplatformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe platform version that your tasks in the service are running on. A platform\u003cbr/\u003eversion is specified only for tasks using the Fargate launch type. If one\u003cbr/\u003eisn\u0026rsquo;t specified, the LATEST platform version is used. For more information,\u003cbr/\u003esee Fargate platform versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003epropagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies whether to propagate the tags from the task definition to the task.\u003cbr/\u003eIf no value is specified, the tags aren\u0026rsquo;t propagated. Tags can only be propagated\u003cbr/\u003eto the task during task creation. To add tags to a task after task creation,\u003cbr/\u003euse the TagResource (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html)\u003cbr/\u003eAPI action.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is NONE. |\n| \u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon\u003cbr/\u003eECS to make calls to your load balancer on your behalf. This parameter is\u003cbr/\u003eonly permitted if you are using a load balancer with your service and your\u003cbr/\u003etask definition doesn\u0026rsquo;t use the awsvpc network mode. If you specify the role\u003cbr/\u003eparameter, you must also specify a load balancer object with the loadBalancers\u003cbr/\u003eparameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your account has already created the Amazon ECS service-linked role, that\u003cbr/\u003erole is used for your service unless you specify a role here. The service-linked\u003cbr/\u003erole is required if your task definition uses the awsvpc network mode or\u003cbr/\u003eif the service is configured to use service discovery, an external deployment\u003cbr/\u003econtroller, multiple target groups, or Elastic Inference accelerators in\u003cbr/\u003ewhich case you don\u0026rsquo;t specify a role here. For more information, see Using\u003cbr/\u003eservice-linked roles for Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf your specified role has a path other than /, then you must either specify\u003cbr/\u003ethe full role ARN (this is recommended) or prefix the role name with the\u003cbr/\u003epath. For example, if a role with the name bar has a path of /foo/ then you\u003cbr/\u003ewould specify /foo/bar as the role name. For more information, see Friendly\u003cbr/\u003enames and paths (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names)\u003cbr/\u003ein the IAM User Guide. |\n| \u003cstrong\u003eroleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003eroleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003eroleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eschedulingStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe scheduling strategy to use for the service. For more information, see\u003cbr/\u003eServices (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThere are two service scheduler strategies available:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * REPLICA-The replica scheduling strategy places and maintains the desired\u003cbr/\u003e number of tasks across your cluster. By default, the service scheduler\u003cbr/\u003e spreads tasks across Availability Zones. You can use task placement strategies\u003cbr/\u003e and constraints to customize task placement decisions. This scheduler\u003cbr/\u003e strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment\u003cbr/\u003e controller types.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DAEMON-The daemon scheduling strategy deploys exactly one task on each\u003cbr/\u003e active container instance that meets all of the task placement constraints\u003cbr/\u003e that you specify in your cluster. The service scheduler also evaluates\u003cbr/\u003e the task placement constraints for running tasks and will stop tasks that\u003cbr/\u003e don\u0026rsquo;t meet the placement constraints. When you\u0026rsquo;re using this strategy,\u003cbr/\u003e you don\u0026rsquo;t need to specify a desired number of tasks, a task placement\u003cbr/\u003e strategy, or use Service Auto Scaling policies. Tasks using the Fargate\u003cbr/\u003e launch type or the CODE_DEPLOY or EXTERNAL deployment controller types\u003cbr/\u003e don\u0026rsquo;t support the DAEMON scheduling strategy. |\n| \u003cstrong\u003eserviceConnectConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for this service to discover and connect to services, and\u003cbr/\u003ebe discovered by, and connected from, other services within a namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eserviceConnectConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect service object configuration. For more information, see\nService Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEach alias (\u0026ldquo;endpoint\u0026rdquo;) is a fully-qualified name and port number that other\ntasks (\u0026ldquo;clients\u0026rdquo;) can use to connect to this service.\u003c/p\u003e\n\u003cp\u003eEach name and port mapping must be unique within the namespace.\u003c/p\u003e\n\u003cp\u003eTasks that run in a namespace can use short names to connect to services\nin the namespace. Tasks can connect to services across all of the clusters\nin the namespace. Tasks connect through a managed proxy container that collects\nlogs and metrics for increased visibility. Only the tasks that Amazon ECS\nservices create are supported with Service Connect. For more information,\nsee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].clientAliases.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].ingressPortOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].portName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the timeout configurations for Service Connect.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf idleTimeout is set to a time that is less than perRequestTimeout, the\u003cbr/\u003econnection will close when the idleTimeout is reached and not the perRequestTimeout. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout.idleTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].timeout.perRequestTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the configuration for Service Connect TLS. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.issuerCertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the Amazon Web Services Private Certificate Authority\u003cbr/\u003ecertificate. |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.issuerCertificateAuthority.awsPCAAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceConnectConfiguration.services.[].tls.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe details of the service discovery registry to associate with this service.\u003cbr/\u003eFor more information, see Service discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach service may be associated with one service registry. Multiple service\u003cbr/\u003eregistries for each service isn\u0026rsquo;t supported. |\n| \u003cstrong\u003eserviceRegistries.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for the service registry.\u003c/p\u003e\n\u003cp\u003eEach service may be associated with one service registry. Multiple service\nregistries for each service are not supported.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove the service registries configuration, Amazon\nECS starts a new deployment. New tasks are registered and deregistered to\nthe updated service registry configuration. || \u003cstrong\u003eserviceRegistries.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceRegistries.[].registryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the service to help you categorize and organize\u003cbr/\u003ethem. Each tag consists of a key and an optional value, both of which you\u003cbr/\u003edefine. When a service is deleted, the tags are deleted as well.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe family and revision (family:revision) or full ARN of the task definition\u003cbr/\u003eto run in your service. If a revision isn\u0026rsquo;t specified, the latest ACTIVE\u003cbr/\u003erevision is used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA task definition must be specified if the service uses either the ECS or\u003cbr/\u003eCODE_DEPLOY deployment controllers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about deployment types, see Amazon ECS deployment types\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). |\n| \u003cstrong\u003etaskDefinitionRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003etaskDefinitionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003etaskDefinitionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\u003cbr/\u003ethat is configured at launch time. Currently, the only supported volume type\u003cbr/\u003eis an Amazon EBS volume. |\n| \u003cstrong\u003evolumeConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\nthat is configured at launch time. Currently, the only supported volume type\nis an Amazon EBS volume. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for the Amazon EBS volume that Amazon ECS creates and manages\u003cbr/\u003eon your behalf. These settings are used to create each Amazon EBS volume,\u003cbr/\u003ewith one volume created for each task in the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\u003cbr/\u003eparameters. |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.filesystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tag specifications of an Amazon EBS volume. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].propagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].resourceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.throughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].managedEBSVolume.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumeConfigurations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusterARN: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedAt: string\ncreatedBy: string\ndeployments:\n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n createdAt: string\n desiredCount: integer\n failedTasks: integer\n id: string\n launchType: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n pendingCount: integer\n platformFamily: string\n platformVersion: string\n rolloutState: string\n rolloutStateReason: string\n runningCount: integer\n serviceConnectConfiguration: \n enabled: boolean\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n namespace: string\n services:\n clientAliases:\n - dnsName: string\n port: integer\n discoveryName: string\n ingressPortOverride: integer\n portName: string\n timeout: \n idleTimeoutSeconds: integer\n perRequestTimeoutSeconds: integer\n tls: \n issuerCertificateAuthority: \n awsPCAAuthorityARN: string\n kmsKey: string\n roleARN: string\n serviceConnectResources:\n - discoveryARN: string\n discoveryName: string\n status: string\n taskDefinition: string\n updatedAt: string\n volumeConfigurations:\n managedEBSVolume: \n encrypted: boolean\n filesystemType: string\n iops: integer\n kmsKeyID: string\n roleARN: string\n sizeInGiB: integer\n snapshotID: string\n tagSpecifications:\n - propagateTags: string\n resourceType: string\n tags:\n - key: string\n value: string\n throughput: integer\n volumeType: string\n name: string\nevents:\n- createdAt: string\n id: string\n message: string\npendingCount: integer\nplatformFamily: string\nroleARN: string\nrunningCount: integer\nstatus: string\ntaskSets:\n capacityProviderStrategy:\n - base: integer\n capacityProvider: string\n weight: integer\n clusterARN: string\n computedDesiredCount: integer\n createdAt: string\n externalID: string\n id: string\n launchType: string\n loadBalancers:\n - containerName: string\n containerPort: integer\n loadBalancerName: string\n targetGroupARN: string\n networkConfiguration: \n awsVPCConfiguration: \n assignPublicIP: string\n securityGroups:\n - string\n subnets:\n - string\n pendingCount: integer\n platformFamily: string\n platformVersion: string\n runningCount: integer\n scale: \n unit: string\n value: number\n serviceARN: string\n serviceRegistries:\n - containerName: string\n containerPort: integer\n port: integer\n registryARN: string\n stabilityStatus: string\n stabilityStatusAt: string\n startedBy: string\n status: string\n tags:\n - key: string\n value: string\n taskDefinition: string\n taskSetARN: string\n updatedAt: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the cluster that hosts the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the service was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe principal that created the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe current state of deployments for the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of an Amazon ECS service deployment. This is used only when a\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice uses the ECS deployment controller type.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeployments.[].capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan be set when using the RunTask or CreateCluster APIs or as the default\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecapacity provider strategy for a cluster with the CreateCluster API.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].desiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].failedTasks\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for a task or service. |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003edeployments.[].pendingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].platformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].platformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].rolloutState\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].rolloutStateReason\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].runningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect configuration of your Amazon ECS service. The configuration\u003cbr/\u003efor this service to discover and connect to services, and be discovered by,\u003cbr/\u003eand connected from, other services within a namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTasks that run in a namespace can use short names to connect to services\u003cbr/\u003ein the namespace. Tasks can connect to services across all of the clusters\u003cbr/\u003ein the namespace. Tasks connect through a managed proxy container that collects\u003cbr/\u003elogs and metrics for increased visibility. Only the tasks that Amazon ECS\u003cbr/\u003eservices create are supported with Service Connect. For more information,\u003cbr/\u003esee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect service object configuration. For more information, see\nService Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEach alias (\u0026ldquo;endpoint\u0026rdquo;) is a fully-qualified name and port number that other\ntasks (\u0026ldquo;clients\u0026rdquo;) can use to connect to this service.\u003c/p\u003e\n\u003cp\u003eEach name and port mapping must be unique within the namespace.\u003c/p\u003e\n\u003cp\u003eTasks that run in a namespace can use short names to connect to services\nin the namespace. Tasks can connect to services across all of the clusters\nin the namespace. Tasks connect through a managed proxy container that collects\nlogs and metrics for increased visibility. Only the tasks that Amazon ECS\nservices create are supported with Service Connect. For more information,\nsee Service Connect (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[].dnsName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].clientAliases.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].ingressPortOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].portName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the timeout configurations for Service Connect.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf idleTimeout is set to a time that is less than perRequestTimeout, the\u003cbr/\u003econnection will close when the idleTimeout is reached and not the perRequestTimeout. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout.idleTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].timeout.perRequestTimeoutSeconds\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the configuration for Service Connect TLS. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.issuerCertificateAuthority\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object that represents the Amazon Web Services Private Certificate Authority\u003cbr/\u003ecertificate. |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.issuerCertificateAuthority.awsPCAAuthorityARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.kmsKey\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectConfiguration.services.[].tls.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Service Connect resource. Each configuration maps a discovery name to\na Cloud Map service name. The data is stored in Cloud Map as part of the\nService Connect configuration for each discovery name of this Amazon ECS\nservice.\u003c/p\u003e\n\u003cp\u003eA task can resolve the dnsName for each of the clientAliases of a service.\nHowever a task can\u0026rsquo;t resolve the discovery names. If you want to connect\nto a service, refer to the ServiceConnectConfiguration of that service for\nthe list of clientAliases that you can use. || \u003cstrong\u003edeployments.[].serviceConnectResources.[].discoveryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].serviceConnectResources.[].discoveryName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].taskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for a volume specified in the task definition as a volume\nthat is configured at launch time. Currently, the only supported volume type\nis an Amazon EBS volume. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration for the Amazon EBS volume that Amazon ECS creates and manages\u003cbr/\u003eon your behalf. These settings are used to create each Amazon EBS volume,\u003cbr/\u003ewith one volume created for each task in the service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eMany of these parameters map 1:1 with the Amazon EBS CreateVolume API request\u003cbr/\u003eparameters. |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.encrypted\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.filesystemType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.iops\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.roleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.snapshotID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tag specifications of an Amazon EBS volume. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].propagateTags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].resourceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.tagSpecifications.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.throughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].managedEBSVolume.volumeType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003edeployments.[].volumeConfigurations.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe event stream for your service. A maximum of 100 of the latest events\u003cbr/\u003eare displayed. |\n| \u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for an event that\u0026rsquo;s associated with a service. || \u003cstrong\u003eevents.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ependingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the PENDING state. |\n| \u003cstrong\u003eplatformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe operating system that your tasks in the service run on. A platform family\u003cbr/\u003eis specified only for tasks using the Fargate launch type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAll tasks that run as part of this service must use the same platformFamily\u003cbr/\u003evalue as the service (for example, LINUX). |\n| \u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the IAM role that\u0026rsquo;s associated with the service. It allows the\u003cbr/\u003eAmazon ECS container agent to register container instances with an Elastic\u003cbr/\u003eLoad Balancing load balancer. |\n| \u003cstrong\u003erunningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of tasks in the cluster that are in the RUNNING state. |\n| \u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. |\n| \u003cstrong\u003etaskSets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about a set of Amazon ECS tasks in either an CodeDeploy or an\u003cbr/\u003eEXTERNAL deployment. An Amazon ECS task set includes details such as the\u003cbr/\u003edesired number of tasks, how many tasks are running, and whether the task\u003cbr/\u003eset serves production traffic. |\n| \u003cstrong\u003etaskSets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about a set of Amazon ECS tasks in either an CodeDeploy or an\nEXTERNAL deployment. An Amazon ECS task set includes details such as the\ndesired number of tasks, how many tasks are running, and whether the task\nset serves production traffic. || \u003cstrong\u003etaskSets.[].capacityProviderStrategy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details of a capacity provider strategy. A capacity provider strategy\ncan be set when using the RunTask or CreateCluster APIs or as the default\ncapacity provider strategy for a cluster with the CreateCluster API.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eOnly capacity providers that are already associated with a cluster and have\nan ACTIVE or UPDATING status can be used in a capacity provider strategy.\nThe PutClusterCapacityProviders API is used to associate a capacity provider\nwith a cluster.\u003c/p\u003e\n\u003cp\u003eIf specifying a capacity provider that uses an Auto Scaling group, the capacity\nprovider must already be created. New Auto Scaling group capacity providers\ncan be created with the CreateCapacityProvider API operation.\u003c/p\u003e\n\u003cp\u003eTo use a Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT\ncapacity providers. The Fargate capacity providers are available to all accounts\nand only need to be associated with a cluster to be used in a capacity provider\nstrategy.\u003c/p\u003e\n\u003cp\u003eA capacity provider strategy may contain a maximum of 6 capacity providers. || \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].base\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].capacityProvider\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].capacityProviderStrategy.[].weight\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].clusterARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].computedDesiredCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].createdAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].externalID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].id\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].launchType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe load balancer configuration to use with a service or task set.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove a load balancer configuration, Amazon ECS\nstarts a new deployment with the updated Elastic Load Balancing configuration.\nThis causes tasks to register to and deregister from load balancers.\u003c/p\u003e\n\u003cp\u003eWe recommend that you verify this on a test environment before you update\nthe Elastic Load Balancing configuration.\u003c/p\u003e\n\u003cp\u003eA service-linked role is required for services that use multiple target groups.\nFor more information, see Using service-linked roles (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003etaskSets.[].loadBalancers.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].loadBalancerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].loadBalancers.[].targetGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe network configuration for a task or service. |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the networking details for a task or service. For\u003cbr/\u003eexample awsvpcConfiguration={subnets=[\u0026ldquo;subnet-12344321\u0026rdquo;],securityGroups=[\u0026ldquo;sg-12344321\u0026rdquo;]} |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.assignPublicIP\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].networkConfiguration.awsVPCConfiguration.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etaskSets.[].pendingCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].platformFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].platformVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].runningCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].scale\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA floating-point percentage of the desired number of tasks to place and keep\u003cbr/\u003erunning in the task set. |\n| \u003cstrong\u003etaskSets.[].scale.unit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].scale.value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for the service registry.\u003c/p\u003e\n\u003cp\u003eEach service may be associated with one service registry. Multiple service\nregistries for each service are not supported.\u003c/p\u003e\n\u003cp\u003eWhen you add, update, or remove the service registries configuration, Amazon\nECS starts a new deployment. New tasks are registered and deregistered to\nthe updated service registry configuration. || \u003cstrong\u003etaskSets.[].serviceRegistries.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].port\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].serviceRegistries.[].registryARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].stabilityStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].stabilityStatusAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].startedBy\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etaskSets.[].tags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].tags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].taskDefinition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].taskSetARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskSets.[].updatedAt\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n'}).add({id:168,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/snapshot/",title:"Snapshot",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#Snapshot"\u003eelasticache-controller/apis/v1alpha1#Snapshot\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshotList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshots\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a copy of an entire Redis cluster as of the time when the snapshot was taken.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecacheClusterID: string\nkmsKeyID: string\nreplicationGroupID: string\nsnapshotName: string\nsourceSnapshotName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheClusterID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of an existing cluster. The snapshot is created from this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe identifier of an existing replication group. The snapshot is created from this replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the snapshot being created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceSnapshotName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an existing snapshot from which to make a copy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nautoMinorVersionUpgrade: boolean\nautomaticFailover: string\ncacheClusterCreateTime: string\ncacheNodeType: string\ncacheParameterGroupName: string\ncacheSubnetGroupName: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndataTiering: string\nengine: string\nengineVersion: string\nnodeSnapshots:\n- cacheClusterID: string\n cacheNodeCreateTime: string\n cacheNodeID: string\n cacheSize: string\n nodeGroupConfiguration: \n nodeGroupID: string\n primaryAvailabilityZone: string\n primaryOutpostARN: string\n replicaAvailabilityZones:\n - string\n replicaCount: integer\n replicaOutpostARNs:\n - string\n slots: string\n nodeGroupID: string\n snapshotCreateTime: string\nnumCacheNodes: integer\nnumNodeGroups: integer\nport: integer\npreferredAvailabilityZone: string\npreferredMaintenanceWindow: string\npreferredOutpostARN: string\nreplicationGroupDescription: string\nsnapshotRetentionLimit: integer\nsnapshotSource: string\nsnapshotStatus: string\nsnapshotWindow: string\ntopicARN: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoMinorVersionUpgrade\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIf you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautomaticFailover\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the status of automatic failover for the source Redis replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheClusterCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the source cluster was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheNodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the compute and memory capacity node type for the source cluster. \u003cbr/\u003e The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts. \u003cbr/\u003e * General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge \u003cbr/\u003e * Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge \u003cbr/\u003e * Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge \u003cbr/\u003e * Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge \u003cbr/\u003e Additional node type info \u003cbr/\u003e * All current generation instance types are created in Amazon VPC by default. \u003cbr/\u003e * Redis append-only files (AOF) are not supported for T1 or T2 instances. \u003cbr/\u003e * Redis Multi-AZ with automatic failover is not supported on T1 instances. \u003cbr/\u003e * Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheParameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe cache parameter group that is associated with the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecacheSubnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache subnet group associated with the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataTiering\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eEnables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the cache engine (memcached or redis) used by the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the cache engine version that is used by the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of the cache nodes in the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an individual cache node in a snapshot of a cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheNodeCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheNodeID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].cacheSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eNode group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.nodeGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.primaryAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.primaryOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].nodeGroupID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enodeSnapshots.[].snapshotCreateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumCacheNodes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of cache nodes in the source cluster. \u003cbr/\u003e For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enumNodeGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe port number used by each cache nodes in the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredAvailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Availability Zone in which the source cluster is located.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredMaintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. \u003cbr/\u003e Valid values for ddd are: \u003cbr/\u003e * sun \u003cbr/\u003e * mon \u003cbr/\u003e * tue \u003cbr/\u003e * wed \u003cbr/\u003e * thu \u003cbr/\u003e * fri \u003cbr/\u003e * sat \u003cbr/\u003e Example: sun:23:00-mon:01:30\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epreferredOutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN (Amazon Resource Name) of the preferred outpost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroupDescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the source replication group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eFor an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it. \u003cbr/\u003e For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation. \u003cbr/\u003e Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the snapshot. Valid values: creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe daily time range during which ElastiCache takes daily snapshots of the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:169,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/snapshot/",title:"Snapshot",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#Snapshot"\u003ememorydb-controller/apis/v1alpha1#Snapshot\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSnapshotList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshots\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esnapshot\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a copy of an entire cluster as of the time when the snapshot was taken.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eclusterName: string\nclusterRef: \n from: \n name: string\nkmsKeyID: string\nkmsKeyRef: \n from: \n name: string\nname: string\nsourceSnapshotName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe snapshot is created from this cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the KMS key used to encrypt the snapshot.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef: \u003cbr/\u003e from: name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the snapshot being created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esourceSnapshotName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of an existing snapshot from which to make a copy.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nclusterConfiguration: \n description: string\n engineVersion: string\n maintenanceWindow: string\n name: string\n nodeType: string\n numShards: integer\n parameterGroupName: string\n port: integer\n shards:\n configuration: \n replicaCount: integer\n slots: string\n name: string\n size: string\n snapshotCreationTime: string\n snapshotRetentionLimit: integer\n snapshotWindow: string\n subnetGroupName: string\n topicARN: string\n vpcID: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsource: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration of the cluster from which the snapshot was taken\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.description\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.engineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.maintenanceWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.nodeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.numShards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.parameterGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.port\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eProvides details of a shard in a snapshot\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].configuration.replicaCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].configuration.slots\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.shards.[].snapshotCreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.snapshotRetentionLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.snapshotWindow\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.subnetGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.topicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclusterConfiguration.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the snapshot. Valid values: creating\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:170,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/stage/",title:"Stage",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#Stage"\u003eapigatewayv2-controller/apis/v1alpha1#Stage\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStageList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estages\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estage\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents an API stage.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessLogSettings: \n destinationARN: string\n format: string\napiID: string\napiRef: \n from: \n name: string\nautoDeploy: boolean\nclientCertificateID: string\ndefaultRouteSettings: \n dataTraceEnabled: boolean\n detailedMetricsEnabled: boolean\n loggingLevel: string\n throttlingBurstLimit: integer\n throttlingRateLimit: number\ndeploymentID: string\ndeploymentRef: \n from: \n name: string\ndescription: string\nrouteSettings: {}\nstageName: string\nstageVariables: {}\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSettings for logging access in a stage.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings.destinationARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRepresents an Amazon Resource Name (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessLogSettings.format\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA string with a length between [1-1024].\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eautoDeploy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientCertificateID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a collection of route settings.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.dataTraceEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.detailedMetricsEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.loggingLevel\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe logging level.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.throttlingBurstLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultRouteSettings.throttlingRateLimit\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003enumber\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeploymentRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteSettings\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estageVariables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\napiGatewayManaged: boolean\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nlastDeploymentStatusMessage: string\nlastUpdatedDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eapiGatewayManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastDeploymentStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:171,href:"https://aws-controllers-k8s.github.io/community/reference/sfn/v1alpha1/statemachine/",title:"StateMachine",description:null,content:'\u003cp\u003e\u003ccode\u003esfn.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sfn-controller/apis/v1alpha1#StateMachine"\u003esfn-controller/apis/v1alpha1#StateMachine\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStateMachine\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStateMachineList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estatemachines\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estatemachine\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edefinition: string\nloggingConfiguration: \n destinations:\n cloudWatchLogsLogGroup: \n logGroupARN: string\n includeExecutionData: boolean\n level: string\nname: string\nroleARN: string\ntags:\n- key: string\n value: string\ntracingConfiguration: \n enabled: boolean\ntype_: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefinition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon States Language definition of the state machine. See Amazon States\u003cbr/\u003eLanguage (https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines what execution history events are logged and where they are logged.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, the level is set to OFF. For more information see Log Levels\u003cbr/\u003e(https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html)\u003cbr/\u003ein the AWS Step Functions User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.destinations.[].cloudWatchLogsLogGroup.logGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.includeExecutionData\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eloggingConfiguration.level\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the state machine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA name must not contain:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * white space\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * brackets \u0026lt; \u0026gt; { } [ ]\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * wildcard characters ? *\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * special characters \u0026quot; # % \\ ^\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the IAM role to use for this state machine.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eTags to be added when creating a state machine.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\u003cbr/\u003eTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\u003cbr/\u003ein the AWS Billing and Cost Management User Guide, and Controlling Access\u003cbr/\u003eUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\u003cbr/\u003e_ . : / = + - @.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eTags are key-value pairs that can be associated with Step Functions state\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emachines and activities.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAn array of key-value pairs. For more information, see Using Cost Allocation\nTags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)\nin the AWS Billing and Cost Management User Guide, and Controlling Access\nUsing IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).\u003c/p\u003e\n\u003cp\u003eTags may only contain Unicode letters, digits, white space, or these symbols:\n_ . : / = + - @. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etracingConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSelects whether AWS X-Ray tracing is enabled. |\n| \u003cstrong\u003etracingConfiguration.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| **type_**\u003cbr/\u003eOptional | **string**\u003cbr/\u003eDetermines whether a Standard or Express state machine is created. The default\u003cbr/\u003eis STANDARD. You cannot update the type of a state machine once it has been\u003cbr/\u003ecreated. |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDate: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date the state machine is created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:172,href:"https://aws-controllers-k8s.github.io/community/reference/kinesis/v1alpha1/stream/",title:"Stream",description:null,content:'\u003cp\u003e\u003ccode\u003ekinesis.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/kinesis-controller/apis/v1alpha1#Stream"\u003ekinesis-controller/apis/v1alpha1#Stream\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStream\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eStreamList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estreams\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003estream\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nshardCount: integer\nstreamModeDetails: \n streamMode: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name to identify the stream. The stream name is scoped to the Amazon Web\u003cbr/\u003eServices account used by the application that creates the stream. It is also\u003cbr/\u003escoped by Amazon Web Services Region. That is, two streams in two different\u003cbr/\u003eAmazon Web Services accounts can have the same name. Two streams in the same\u003cbr/\u003eAmazon Web Services account but in two different Regions can also have the\u003cbr/\u003esame name.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eshardCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of shards that the stream will use. The throughput of the stream\u003cbr/\u003eis a function of the number of shards; more shards are required for greater\u003cbr/\u003eprovisioned throughput.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamModeDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eIndicates the capacity mode of the data stream. Currently, in Kinesis Data\u003cbr/\u003eStreams, you can choose between an on-demand capacity mode and a provisioned\u003cbr/\u003ecapacity mode for your data streams.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamModeDetails.streamMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconsumerCount: integer\nencryptionType: string\nenhancedMonitoring:\n shardLevelMetrics:\n - string\nkeyID: string\nopenShardCount: integer\nretentionPeriodHours: integer\nstreamCreationTimestamp: string\nstreamStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econsumerCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of enhanced fan-out consumers registered with the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe encryption type used. This value is one of the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KMS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * NONE\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents the current enhanced monitoring settings of the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents enhanced metrics types.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenhancedMonitoring.[].shardLevelMetrics.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eopenShardCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of open shards in the stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretentionPeriodHours\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe current retention period, in hours.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamCreationTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe approximate time that the stream was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estreamStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current status of the stream being described. The stream status is one\u003cbr/\u003eof the following states:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The stream is being created. Kinesis Data Streams immediately\u003cbr/\u003e returns and sets StreamStatus to CREATING.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The stream is being deleted. The specified stream is in the\u003cbr/\u003e DELETING state until Kinesis Data Streams completes the deletion.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The stream exists and is ready for read and write operations\u003cbr/\u003e or deletion. You should perform read and write operations only on an ACTIVE\u003cbr/\u003e stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - Shards in the stream are being merged or split. Read and\u003cbr/\u003e write operations continue to work while the stream is in the UPDATING\u003cbr/\u003e state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:173,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/subnet/",title:"Subnet",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#Subnet"\u003eec2-controller/apis/v1alpha1#Subnet\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnets\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnet\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a subnet.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eassignIPv6AddressOnCreation: boolean\navailabilityZone: string\navailabilityZoneID: string\ncidrBlock: string\ncustomerOwnedIPv4Pool: string\nenableDNS64: boolean\nenableResourceNameDNSAAAARecord: boolean\nenableResourceNameDNSARecord: boolean\nhostnameType: string\nipv6CIDRBlock: string\nipv6Native: boolean\nmapPublicIPOnLaunch: boolean\noutpostARN: string\nrouteTableRefs:\n from: \n name: string\nrouteTables:\n- string\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eassignIPv6AddressOnCreation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZone\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Availability Zone or Local Zone for the subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Amazon Web Services selects one for you. If you create more than\u003cbr/\u003eone subnet in your VPC, we do not necessarily select a different zone for\u003cbr/\u003eeach subnet.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a subnet in a Local Zone, set this value to the Local Zone ID,\u003cbr/\u003efor example us-west-2-lax-1a. For information about the Regions that support\u003cbr/\u003eLocal Zones, see Available Regions (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo create a subnet in an Outpost, set this value to the Availability Zone\u003cbr/\u003efor the Outpost and specify the Outpost ARN.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe AZ ID or the Local Zone ID of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.\u003cbr/\u003eWe modify the specified CIDR block to its canonical form; for example, if\u003cbr/\u003eyou specify 100.68.0.18/18, we modify it to 100.68.0.0/18.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecustomerOwnedIPv4Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableDNS64\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 network range for the subnet, in CIDR notation. The subnet size\u003cbr/\u003emust use a /64 prefix length.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is required for an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Native\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether to create an IPv6 only subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emapPublicIPOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutpostARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost\u003cbr/\u003eARN, you must also specify the Availability Zone of the Outpost subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erouteTables.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailableIPAddressCount: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndefaultForAZ: boolean\nenableLniAtDeviceIndex: integer\nipv6CIDRBlockAssociationSet:\n- associationID: string\n ipv6CIDRBlock: string\n ipv6CIDRBlockState: \n state: string\n statusMessage: string\nmapCustomerOwnedIPOnLaunch: boolean\nownerID: string\nprivateDNSNameOptionsOnLaunch: \n enableResourceNameDNSAAAARecord: boolean\n enableResourceNameDNSARecord: boolean\n hostnameType: string\nstate: string\nsubnetID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailableIPAddressCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of unused private IPv4 addresses in the subnet. The IPv4 addresses\u003cbr/\u003efor any stopped instances are considered unavailable.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultForAZ\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether this is the default subnet for the Availability Zone.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableLniAtDeviceIndex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eIndicates the device position for local network interfaces in this subnet.\u003cbr/\u003eFor example, 1 indicates local network interfaces in this subnet are the\u003cbr/\u003esecondary network interface (eth1).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv6 CIDR blocks associated with the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an association between a subnet and an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emapCustomerOwnedIPOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether a network interface created in this subnet (including a\u003cbr/\u003enetwork interface created by RunInstances) receives a customer-owned IPv4\u003cbr/\u003eaddress.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type of hostnames to assign to instances in the subnet at launch. An\u003cbr/\u003einstance hostname is based on the IPv4 address or ID of the instance.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.enableResourceNameDNSAAAARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.enableResourceNameDNSARecord\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameOptionsOnLaunch.hostnameType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the subnet.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:174,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/subnetgroup/",title:"SubnetGroup",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#SubnetGroup"\u003ememorydb-controller/apis/v1alpha1#SubnetGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubnetGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnetgroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubnetgroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents the output of one of the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003eCreateSubnetGroup\u003c/li\u003e\n\u003cli\u003eUpdateSubnetGroup\nA subnet group is a collection of subnets (typically private) that you can designate for your clusters running in an Amazon Virtual Private Cloud (VPC) environment.\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\nname: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of VPC subnet IDs for the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field Ex: APIIDRef:\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efrom: name: my-api\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nsubnets:\n availabilityZone: \n name: string\n identifier: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of subnets associated with the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].availabilityZone.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnets.[].identifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:175,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/subscription/",title:"Subscription",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#Subscription"\u003esns-controller/apis/v1alpha1#Subscription\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubscription\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eSubscriptionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubscriptions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003esubscription\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA wrapper type for the attributes of an Amazon SNS subscription.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edeliveryPolicy: string\nendpoint: string\nfilterPolicy: string\nfilterPolicyScope: string\nprotocol: string\nrawMessageDelivery: string\nredrivePolicy: string\nsubscriptionRoleARN: string\ntopicARN: string\ntopicRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eendpoint\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe endpoint that you want to receive notifications. Endpoints vary by protocol:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the http protocol, the (public) endpoint is a URL beginning with\u003cbr/\u003e http://.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the https protocol, the (public) endpoint is a URL beginning with\u003cbr/\u003e https://.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the email protocol, the endpoint is an email address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the email-json protocol, the endpoint is an email address.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the sms protocol, the endpoint is a phone number of an SMS-enabled\u003cbr/\u003e device.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the application protocol, the endpoint is the EndpointArn of a mobile\u003cbr/\u003e app and device.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the lambda protocol, the endpoint is the ARN of an Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For the firehose protocol, the endpoint is the ARN of an Amazon Kinesis\u003cbr/\u003e Data Firehose delivery stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efilterPolicyScope\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprotocol\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe protocol that you want to use. Supported protocols include:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * http – delivery of JSON-encoded message via HTTP POST\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * https – delivery of JSON-encoded message via HTTPS POST\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * email – delivery of message via SMTP\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * email-json – delivery of JSON-encoded message via SMTP\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sms – delivery of message via SMS\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * sqs – delivery of JSON-encoded message to an Amazon SQS queue\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * application – delivery of JSON-encoded message to an EndpointArn for\u003cbr/\u003e a mobile app and device\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * lambda – delivery of JSON-encoded message to an Lambda function\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * firehose – delivery of JSON-encoded message to an Amazon Kinesis Data\u003cbr/\u003e Firehose delivery stream.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erawMessageDelivery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eredrivePolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubscriptionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the topic you want to subscribe to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nconfirmationWasAuthenticated: string\neffectiveDeliveryPolicy: string\nowner: string\npendingConfirmation: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econfirmationWasAuthenticated\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeffectiveDeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingConfirmation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:176,href:"https://aws-controllers-k8s.github.io/community/reference/dynamodb/v1alpha1/table/",title:"Table",description:null,content:'\u003cp\u003e\u003ccode\u003edynamodb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/dynamodb-controller/apis/v1alpha1#Table"\u003edynamodb-controller/apis/v1alpha1#Table\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eattributeDefinitions:\n- attributeName: string\n attributeType: string\nbillingMode: string\ncontinuousBackups: \n pointInTimeRecoveryEnabled: boolean\ndeletionProtectionEnabled: boolean\nglobalSecondaryIndexes:\n- indexName: string\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\n provisionedThroughput: \n readCapacityUnits: integer\n writeCapacityUnits: integer\nkeySchema:\n- attributeName: string\n keyType: string\nlocalSecondaryIndexes:\n- indexName: string\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\nprovisionedThroughput: \n readCapacityUnits: integer\n writeCapacityUnits: integer\nsseSpecification: \n enabled: boolean\n kmsMasterKeyID: string\n sseType: string\nstreamSpecification: \n streamEnabled: boolean\n streamViewType: string\ntableClass: string\ntableName: string\ntags:\n- key: string\n value: string\ntimeToLive: \n attributeName: string\n enabled: boolean\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of attributes that describe the key schema for the table and indexes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents an attribute for describing the key schema for the table and indexes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eattributeDefinitions.[].attributeType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebillingMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eControls how you are charged for read and write throughput and how you manage\u003cbr/\u003ecapacity. This setting can be changed later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PROVISIONED - We recommend using PROVISIONED for predictable workloads.\u003cbr/\u003e PROVISIONED sets the billing mode to Provisioned Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable\u003cbr/\u003e workloads. PAY_PER_REQUEST sets the billing mode to On-Demand Mode (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtinuousBackups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable point in time recovery.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtinuousBackups.pointInTimeRecoveryEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeletionProtectionEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether deletion protection is to be enabled (true) or disabled\u003cbr/\u003e(false) on the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more global secondary indexes (the maximum is 20) to be created on\u003cbr/\u003ethe table. Each global secondary index in the array includes the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IndexName - The name of the global secondary index. Must be unique only\u003cbr/\u003e for this table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeySchema - Specifies the key schema for the global secondary index.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Projection - Specifies attributes that are copied (projected) from the\u003cbr/\u003e table into the index. These are in addition to the primary key attributes\u003cbr/\u003e and index key attributes, which are automatically projected. Each attribute\u003cbr/\u003e specification is composed of: ProjectionType - One of the following: KEYS_ONLY\u003cbr/\u003e - Only the index and primary keys are projected into the index. INCLUDE\u003cbr/\u003e - Only the specified table attributes are projected into the index. The\u003cbr/\u003e list of projected attributes is in NonKeyAttributes. ALL - All of the\u003cbr/\u003e table attributes are projected into the index. NonKeyAttributes - A list\u003cbr/\u003e of one or more non-key attribute names that are projected into the secondary\u003cbr/\u003e index. The total count of attributes provided in NonKeyAttributes, summed\u003cbr/\u003e across all of the secondary indexes, must not exceed 100. If you project\u003cbr/\u003e the same attribute into two different indexes, this counts as two distinct\u003cbr/\u003e attributes when determining the total.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ProvisionedThroughput - The provisioned throughput settings for the\u003cbr/\u003e global secondary index, consisting of read and write capacity units.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a global secondary index.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat make up the primary key of a table, or the key attributes of an index.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eglobalSecondaryIndexes.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for a specified table or index.\u003cbr/\u003eThe settings can be modified using the UpdateTable operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor current minimum and maximum provisioned throughput values, see Service,\u003cbr/\u003eAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexes.[].provisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ekeySchema\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eSpecifies the attributes that make up the primary key for a table or an index.\u003cbr/\u003eThe attributes in KeySchema must also be defined in the AttributeDefinitions\u003cbr/\u003earray. For more information, see Data Model (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach KeySchemaElement in the array is composed of:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * AttributeName - The name of this key attribute.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeyType - The role that the key attribute will assume: HASH - partition\u003cbr/\u003e key RANGE - sort key\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe partition key of an item is also known as its hash attribute. The term\u003cbr/\u003e\u0026ldquo;hash attribute\u0026rdquo; derives from the DynamoDB usage of an internal hash function\u003cbr/\u003eto evenly distribute data items across partitions, based on their partition\u003cbr/\u003ekey values.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe sort key of an item is also known as its range attribute. The term \u0026ldquo;range\u003cbr/\u003eattribute\u0026rdquo; derives from the way DynamoDB stores items with the same partition\u003cbr/\u003ekey physically close together, in sorted order by the sort key value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a simple primary key (partition key), you must provide exactly one element\u003cbr/\u003ewith a KeyType of HASH.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a composite primary key (partition key and sort key), you must provide\u003cbr/\u003eexactly two elements, in this order: The first element must have a KeyType\u003cbr/\u003eof HASH, and the second element must have a KeyType of RANGE.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Working with Tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003ekeySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003ekeySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ekeySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eOne or more local secondary indexes (the maximum is 5) to be created on the\u003cbr/\u003etable. Each index is scoped to a given partition key value. There is a 10\u003cbr/\u003eGB size limit per partition key value; otherwise, the size of a local secondary\u003cbr/\u003eindex is unconstrained.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eEach local secondary index in the array includes the following:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * IndexName - The name of the local secondary index. Must be unique only\u003cbr/\u003e for this table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * KeySchema - Specifies the key schema for the local secondary index.\u003cbr/\u003e The key schema must begin with the same partition key as the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Projection - Specifies attributes that are copied (projected) from the\u003cbr/\u003e table into the index. These are in addition to the primary key attributes\u003cbr/\u003e and index key attributes, which are automatically projected. Each attribute\u003cbr/\u003e specification is composed of: ProjectionType - One of the following: KEYS_ONLY\u003cbr/\u003e - Only the index and primary keys are projected into the index. INCLUDE\u003cbr/\u003e - Only the specified table attributes are projected into the index. The\u003cbr/\u003e list of projected attributes is in NonKeyAttributes. ALL - All of the\u003cbr/\u003e table attributes are projected into the index. NonKeyAttributes - A list\u003cbr/\u003e of one or more non-key attribute names that are projected into the secondary\u003cbr/\u003e index. The total count of attributes provided in NonKeyAttributes, summed\u003cbr/\u003e across all of the secondary indexes, must not exceed 100. If you project\u003cbr/\u003e the same attribute into two different indexes, this counts as two distinct\u003cbr/\u003e attributes when determining the total. |\n| \u003cstrong\u003elocalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a local secondary index. || \u003cstrong\u003elocalSecondaryIndexes.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\nthat make up the primary key of a table, or the key attributes of an index.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003elocalSecondaryIndexes.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003elocalSecondaryIndexes.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprovisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for a specified table or index.\u003cbr/\u003eThe settings can be modified using the UpdateTable operation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you set BillingMode as PROVISIONED, you must specify this property. If\u003cbr/\u003eyou set BillingMode as PAY_PER_REQUEST, you cannot specify this property.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor current minimum and maximum provisioned throughput values, see Service,\u003cbr/\u003eAccount, and Table Quotas (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)\u003cbr/\u003ein the Amazon DynamoDB Developer Guide. |\n| \u003cstrong\u003eprovisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eprovisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable server-side encryption. |\n| \u003cstrong\u003esseSpecification.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification.kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esseSpecification.sseType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estreamSpecification\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for DynamoDB Streams on the table. These settings consist of:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamEnabled - Indicates whether DynamoDB Streams is to be enabled\u003cbr/\u003e (true) or disabled (false).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamViewType - When an item in the table is modified, StreamViewType\u003cbr/\u003e determines what information is written to the table\u0026rsquo;s stream. Valid values\u003cbr/\u003e for StreamViewType are: KEYS_ONLY - Only the key attributes of the modified\u003cbr/\u003e item are written to the stream. NEW_IMAGE - The entire item, as it appears\u003cbr/\u003e after it was modified, is written to the stream. OLD_IMAGE - The entire\u003cbr/\u003e item, as it appeared before it was modified, is written to the stream.\u003cbr/\u003e NEW_AND_OLD_IMAGES - Both the new and the old item images of the item\u003cbr/\u003e are written to the stream. |\n| \u003cstrong\u003estreamSpecification.streamEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003estreamSpecification.streamViewType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etableClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS. |\n| \u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table to create. |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pairs to label the table. For more information, see Tagging\u003cbr/\u003efor DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html). |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\na single DynamoDB table.\u003c/p\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor an overview on tagging DynamoDB resources, see Tagging for DynamoDB (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html)\nin the Amazon DynamoDB Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etimeToLive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the settings used to enable or disable Time to Live for the specified\u003cbr/\u003etable. |\n| \u003cstrong\u003etimeToLive.attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etimeToLive.enabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\narchivalSummary: \n archivalBackupARN: string\n archivalDateTime: string\n archivalReason: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationDateTime: string\nglobalSecondaryIndexesDescriptions:\n- backfilling: boolean\n indexARN: string\n indexName: string\n indexSizeBytes: integer\n indexStatus: string\n itemCount: integer\n keySchema:\n - attributeName: string\n keyType: string\n projection: \n nonKeyAttributes:\n - string\n projectionType: string\n provisionedThroughput: \n lastDecreaseDateTime: string\n lastIncreaseDateTime: string\n numberOfDecreasesToday: integer\n readCapacityUnits: integer\n writeCapacityUnits: integer\nglobalTableVersion: string\nitemCount: integer\nlatestStreamARN: string\nlatestStreamLabel: string\nreplicas:\n globalSecondaryIndexes:\n - indexName: string\n provisionedThroughputOverride: \n readCapacityUnits: integer\n kmsMasterKeyID: string\n provisionedThroughputOverride: \n readCapacityUnits: integer\n regionName: string\n replicaInaccessibleDateTime: string\n replicaStatus: string\n replicaStatusDescription: string\n replicaStatusPercentProgress: string\n replicaTableClassSummary: \n lastUpdateDateTime: string\n tableClass: string\nrestoreSummary: \n restoreDateTime: string\n restoreInProgress: boolean\n sourceBackupARN: string\n sourceTableARN: string\ntableID: string\ntableSizeBytes: integer\ntableStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the table archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalBackupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchivalSummary.archivalReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationDateTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time when the table was created, in UNIX epoch time (http://www.epochconverter.com/)\u003cbr/\u003eformat.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a global secondary index.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].indexStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].itemCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single element of a key schema. A key schema specifies the attributes\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethat make up the primary key of a table, or the key attributes of an index.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA KeySchemaElement represents exactly one attribute of the primary key. For\nexample, a simple primary key would be represented by one KeySchemaElement\n(for the partition key). A composite primary key would require one KeySchemaElement\nfor the partition key, and another KeySchemaElement for the sort key.\u003c/p\u003e\n\u003cp\u003eA KeySchemaElement must be a scalar, top-level attribute (not a nested attribute).\nThe data type must be one of String, Number, or Binary. The attribute cannot\nbe nested within a List or a Map. || \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[].attributeName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].keySchema.[].keyType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents attributes that are copied (projected) from the table into an\u003cbr/\u003eindex. These are in addition to the primary key attributes and index key\u003cbr/\u003eattributes, which are automatically projected. |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.nonKeyAttributes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.nonKeyAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].projection.projectionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the provisioned throughput settings for the table, consisting\u003cbr/\u003eof read and write capacity units, along with data about increases and decreases. |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.lastDecreaseDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.lastIncreaseDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.numberOfDecreasesToday\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalSecondaryIndexesDescriptions.[].provisionedThroughput.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eglobalTableVersion\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRepresents the version of global tables (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html)\u003cbr/\u003ein use, if the table is replicated across Amazon Web Services Regions. |\n| \u003cstrong\u003eitemCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe number of items in the specified table. DynamoDB updates this value approximately\u003cbr/\u003eevery six hours. Recent changes might not be reflected in this value. |\n| \u003cstrong\u003elatestStreamARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) that uniquely identifies the latest stream\u003cbr/\u003efor this table. |\n| \u003cstrong\u003elatestStreamLabel\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp, in ISO 8601 format, for this stream.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eNote that LatestStreamLabel is not a unique identifier for the stream, because\u003cbr/\u003eit is possible that a stream from another table might have the same timestamp.\u003cbr/\u003eHowever, the combination of the following three elements is guaranteed to\u003cbr/\u003ebe unique:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon Web Services customer ID\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Table name\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * StreamLabel |\n| \u003cstrong\u003ereplicas\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eRepresents replicas of the table. |\n| \u003cstrong\u003ereplicas.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains the details of the replica. || \u003cstrong\u003ereplicas.[].globalSecondaryIndexes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents the properties of a replica global secondary index. || \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].indexName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].provisionedThroughputOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReplica-specific provisioned throughput settings. If not specified, uses\u003cbr/\u003ethe source table\u0026rsquo;s provisioned throughput settings. |\n| \u003cstrong\u003ereplicas.[].globalSecondaryIndexes.[].provisionedThroughputOverride.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].kmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].provisionedThroughputOverride\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eReplica-specific provisioned throughput settings. If not specified, uses\u003cbr/\u003ethe source table\u0026rsquo;s provisioned throughput settings. |\n| \u003cstrong\u003ereplicas.[].provisionedThroughputOverride.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].regionName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaInaccessibleDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatusDescription\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaStatusPercentProgress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details of the table class. |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary.lastUpdateDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ereplicas.[].replicaTableClassSummary.tableClass\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains details for the restore. |\n| \u003cstrong\u003erestoreSummary.restoreDateTime\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.restoreInProgress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.sourceBackupARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erestoreSummary.sourceTableARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etableID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eUnique identifier for the table for which the backup was created. |\n| \u003cstrong\u003etableSizeBytes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe total size of the specified table, in bytes. DynamoDB updates this value\u003cbr/\u003eapproximately every six hours. Recent changes might not be reflected in this\u003cbr/\u003evalue. |\n| \u003cstrong\u003etableStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the table:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CREATING - The table is being created.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UPDATING - The table/index configuration is being updated. The table/index\u003cbr/\u003e remains available for data operations when UPDATING.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DELETING - The table is being deleted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ACTIVE - The table is ready for use.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the\u003cbr/\u003e table in inaccessible. Table operations may fail due to failure to use\u003cbr/\u003e the KMS key. DynamoDB will initiate the table archival process when a\u003cbr/\u003e table\u0026rsquo;s KMS key remains inaccessible for more than seven days.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARCHIVING - The table is being archived. Operations are not allowed\u003cbr/\u003e until archival is complete.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * ARCHIVED - The table has been archived. See the ArchivalReason for more\u003cbr/\u003e information. |\u003c/p\u003e\n'}).add({id:177,href:"https://aws-controllers-k8s.github.io/community/reference/keyspaces/v1alpha1/table/",title:"Table",description:null,content:'\u003cp\u003e\u003ccode\u003ekeyspaces.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/keyspaces-controller/apis/v1alpha1#Table"\u003ekeyspaces-controller/apis/v1alpha1#Table\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTableList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etables\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etable\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecapacitySpecification: \n readCapacityUnits: integer\n throughputMode: string\n writeCapacityUnits: integer\nclientSideTimestamps: \n status: string\ncomment: \n message: string\ndefaultTimeToLive: integer\nencryptionSpecification: \n kmsKeyIdentifier: string\n type_: string\nkeyspaceName: string\npointInTimeRecovery: \n status: string\nschemaDefinition: \n allColumns:\n - name: string\n type_: string\n clusteringKeys:\n - name: string\n orderBy: string\n partitionKeys:\n - name: string\n staticColumns:\n - name: string\ntableName: string\ntags:\n- key: string\n value: string\nttl: \n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the read/write throughput capacity mode for the table. The options\u003cbr/\u003eare:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * throughputMode:PAY_PER_REQUEST and\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits\u003cbr/\u003e and writeCapacityUnits as input.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is throughput_mode:PAY_PER_REQUEST.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Read/write capacity modes (https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.readCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.throughputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecapacitySpecification.writeCapacityUnits\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientSideTimestamps\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnables client-side timestamps for the table. By default, the setting is\u003cbr/\u003edisabled. You can enable client-side timestamps with the following option:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status: \u0026ldquo;enabled\u0026rdquo;\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eOnce client-side timestamps are enabled for a table, this setting cannot\u003cbr/\u003ebe disabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eclientSideTimestamps.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter allows to enter a description of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecomment.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edefaultTimeToLive\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe default Time to Live setting in seconds for the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Setting the default TTL value for a table (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionSpecification\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies how the encryption key for encryption at rest is managed for the\u003cbr/\u003etable. You can choose one of the following KMS key (KMS key):\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and\u003cbr/\u003e is created, owned, and managed by you. This option requires the kms_key_identifier\u003cbr/\u003e of the KMS key in Amazon Resource Name (ARN) format as input.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is type:AWS_OWNED_KMS_KEY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Encryption at rest (https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eencryptionSpecification.kmsKeyIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**encryptionSpecification.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekeyspaceName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the keyspace that the table is going to be created in.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epointInTimeRecovery\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies if pointInTimeRecovery is enabled or disabled for the table. The\u003cbr/\u003eoptions are:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status=ENABLED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status=DISABLED\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf it\u0026rsquo;s not specified, the default is status=DISABLED.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Point-in-time recovery (https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epointInTimeRecovery.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe schemaDefinition consists of the following parameters.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor each column to be created:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type - An Amazon Keyspaces data type. For more information, see Data\u003cbr/\u003e types (https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types)\u003cbr/\u003e in the Amazon Keyspaces Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe primary key of the table consists of the following columns:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * partitionKeys - The partition key can be a single column, or it can\u003cbr/\u003e be a compound value composed of two or more columns. The partition key\u003cbr/\u003e portion of the primary key is required and determines how Amazon Keyspaces\u003cbr/\u003e stores your data.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of each partition key column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * clusteringKeys - The optional clustering column portion of your primary\u003cbr/\u003e key determines how the data is clustered and sorted within each partition.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the clustering column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * orderBy - Sets the ascendant (ASC) or descendant (DESC) order modifier.\u003cbr/\u003e To define a column as static use staticColumns - Static columns store\u003cbr/\u003e values that are shared by all rows in the same partition:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * name - The name of the column.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * type - An Amazon Keyspaces data type.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.allColumns\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.allColumns.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe names and data types of regular columns.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**schemaDefinition.allColumns.[].type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe optional clustering column portion of your primary key determines how\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ethe data is clustered and sorted within each partition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.clusteringKeys.[].orderBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.partitionKeys\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.partitionKeys.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe partition key portion of the primary key is required and determines how\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAmazon Keyspaces stores the data. The partition key can be a single column,\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eor it can be a compound value composed of two or more columns.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.staticColumns\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eschemaDefinition.staticColumns.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe static columns of the table. Static columns store values that are shared\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eby all rows in the same partition.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etableName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the table.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of key-value pair tags to be attached to the resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\u003cbr/\u003e(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. A tag is a key-value pair. You can add up to 50 tags to\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea single Amazon Keyspaces resource.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eAmazon Web Services-assigned tag names and values are automatically assigned\nthe aws: prefix, which the user cannot assign. Amazon Web Services-assigned\ntag names do not count towards the tag limit of 50. User-assigned tag names\nhave the prefix user: in the Cost Allocation Report. You cannot backdate\nthe application of a tag.\u003c/p\u003e\n\u003cp\u003eFor more information, see Adding tags and labels to Amazon Keyspaces resources\n(https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html)\nin the Amazon Keyspaces Developer Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ettl\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eEnables Time to Live custom settings for the table. The options are:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status:enabled\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * status:disabled\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe default is status:disabled. After ttl is enabled, you can\u0026rsquo;t disable it\u003cbr/\u003efor the table.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Expiring data by using Amazon Keyspaces Time to\u003cbr/\u003eLive (TTL) (https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html)\u003cbr/\u003ein the Amazon Keyspaces Developer Guide. |\n| \u003cstrong\u003ettl.status\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:178,href:"https://aws-controllers-k8s.github.io/community/reference/ecs/v1alpha1/taskdefinition/",title:"TaskDefinition",description:null,content:'\u003cp\u003e\u003ccode\u003eecs.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ecs-controller/apis/v1alpha1#TaskDefinition"\u003eecs-controller/apis/v1alpha1#TaskDefinition\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTaskDefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTaskDefinitionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etaskdefinitions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etaskdefinition\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe details of a task definition which describes the container and volume\ndefinitions of an Amazon Elastic Container Service task. You can specify\nwhich Docker images to use, the required resources, and other configurations\nrelated to launching the task definition through an Amazon ECS service or\ntask.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainerDefinitions:\n command:\n - string\n cpu: integer\n credentialSpecs:\n - string\n dependsOn:\n - condition: string\n containerName: string\n disableNetworking: boolean\n dnsSearchDomains:\n - string\n dnsServers:\n - string\n dockerLabels: {}\n dockerSecurityOptions:\n - string\n entryPoint:\n - string\n environment:\n - name: string\n value: string\n environmentFiles:\n - type: string\n value: string\n essential: boolean\n extraHosts:\n - hostname: string\n ipAddress: string\n firelensConfiguration: \n options: {}\n type: string\n healthCheck: \n command:\n - string\n interval: integer\n retries: integer\n startPeriod: integer\n timeout: integer\n hostname: string\n image: string\n interactive: boolean\n links:\n - string\n linuxParameters: \n capabilities: \n add:\n - string\n drop:\n - string\n devices:\n - containerPath: string\n hostPath: string\n permissions:\n - string\n initProcessEnabled: boolean\n maxSwap: integer\n sharedMemorySize: integer\n swappiness: integer\n tmpfs:\n - containerPath: string\n mountOptions:\n - string\n size: integer\n logConfiguration: \n logDriver: string\n options: {}\n secretOptions:\n - name: string\n valueFrom: string\n memory: integer\n memoryReservation: integer\n mountPoints:\n - containerPath: string\n readOnly: boolean\n sourceVolume: string\n name: string\n portMappings:\n - appProtocol: string\n containerPort: integer\n containerPortRange: string\n hostPort: integer\n name: string\n protocol: string\n privileged: boolean\n pseudoTerminal: boolean\n readonlyRootFilesystem: boolean\n repositoryCredentials: \n credentialsParameter: string\n resourceRequirements:\n - type: string\n value: string\n secrets:\n - name: string\n valueFrom: string\n startTimeout: integer\n stopTimeout: integer\n systemControls:\n - namespace: string\n value: string\n ulimits:\n - hardLimit: integer\n name: string\n softLimit: integer\n user: string\n volumesFrom:\n - readOnly: boolean\n sourceContainer: string\n workingDirectory: string\ncpu: string\nephemeralStorage: \n sizeInGiB: integer\nexecutionRoleARN: string\nfamily: string\ninferenceAccelerators:\n- deviceName: string\n deviceType: string\nipcMode: string\nmemory: string\nnetworkMode: string\npidMode: string\nplacementConstraints:\n- expression: string\n type: string\nproxyConfiguration: \n containerName: string\n properties:\n - name: string\n value: string\n type: string\nrequiresCompatibilities:\n- string\nruntimePlatform: \n cpuArchitecture: string\n operatingSystemFamily: string\ntags:\n- key: string\n value: string\ntaskRoleARN: string\ntaskRoleRef: \n from: \n name: string\nvolumes:\n- configuredAtLaunch: boolean\n dockerVolumeConfiguration: \n autoprovision: boolean\n driver: string\n driverOpts: {}\n labels: {}\n scope: string\n efsVolumeConfiguration: \n authorizationConfig: \n accessPointID: string\n iam: string\n fileSystemID: string\n rootDirectory: string\n transitEncryption: string\n transitEncryptionPort: integer\n fsxWindowsFileServerVolumeConfiguration: \n authorizationConfig: \n credentialsParameter: string\n domain: string\n fileSystemID: string\n rootDirectory: string\n host: \n sourcePath: string\n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of container definitions in JSON format that describe the different\u003cbr/\u003econtainers that make up your task.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContainer definitions are used in task definitions to describe the different\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtainers that are launched as part of a task.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].credentialSpecs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].credentialSpecs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerDefinitions.[].dependsOn.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe dependencies defined for container startup and shutdown. A container\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecan contain multiple dependencies. When a dependency is defined for container\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003estartup, for container shutdown it is reversed.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYour Amazon ECS container instances require at least version 1.26.0 of the\ncontainer agent to use container dependencies. However, we recommend using\nthe latest container agent version. For information about checking your agent\nversion and updating to the latest version, see Updating the Amazon ECS Container\nAgent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html)\nin the Amazon Elastic Container Service Developer Guide. If you\u0026rsquo;re using\nan Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1\nof the ecs-init package. If your container instances are launched from version\n20190301 or later, then they contain the required versions of the container\nagent and ecs-init. For more information, see Amazon ECS-optimized Linux\nAMI (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eFor tasks that use the Fargate launch type, the task or service requires\nthe following platforms:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.3.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information about how to create a container dependency, see Container\ndependency (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/example_task_definitions.html#example_task_definition-containerdependency)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].dependsOn.[].condition\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dependsOn.[].containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].disableNetworking\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsSearchDomains\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsSearchDomains.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].dnsServers\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dnsServers.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].dockerLabels\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dockerSecurityOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].dockerSecurityOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].entryPoint\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].environment\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environment.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object. || \u003cstrong\u003econtainerDefinitions.[].environment.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environment.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of files containing the environment variables to pass to a container.\nYou can specify up to ten environment files. The file must have a .env file\nextension. Each line in an environment file should contain an environment\nvariable in VARIABLE=VALUE format. Lines beginning with # are treated as\ncomments and are ignored.\u003c/p\u003e\n\u003cp\u003eIf there are environment variables specified using the environment parameter\nin a container definition, they take precedence over the variables contained\nwithin an environment file. If multiple environment files are specified that\ncontain the same variable, they\u0026rsquo;re processed from the top down. We recommend\nthat you use unique variable names. For more information, see Specifying\nenvironment variables (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eYou must use the following platforms for the Fargate launch type:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eLinux platform version 1.4.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eWindows platform version 1.0.0 or later.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eConsider the following when using the Fargate launch type:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eThe file is handled like a native Docker env-file.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThere is no support for shell escape handling.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eThe container entry point interperts the VARIABLE values. || \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].environmentFiles.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].essential\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eHostnames and IP address entries that are added to the /etc/hosts file of\na container via the extraHosts parameter of its ContainerDefinition. || \u003cstrong\u003econtainerDefinitions.[].extraHosts.[].hostname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].extraHosts.[].ipAddress\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe FireLens configuration for the container. This is used to specify and\u003cbr/\u003econfigure a log router for container logs. For more information, see Custom\u003cbr/\u003elog routing (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].firelensConfiguration.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container health check. Health check parameters\u003cbr/\u003ethat are specified in a container definition override any Docker health checks\u003cbr/\u003ethat exist in the container image (such as those specified in a parent image\u003cbr/\u003eor from the image\u0026rsquo;s Dockerfile). This configuration maps to the HEALTHCHECK\u003cbr/\u003eparameter of docker run (https://docs.docker.com/engine/reference/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe Amazon ECS container agent only monitors and reports on the health checks\u003cbr/\u003especified in the task definition. Amazon ECS does not monitor Docker health\u003cbr/\u003echecks that are embedded in a container image and not specified in the container\u003cbr/\u003edefinition. Health check parameters that are specified in a container definition\u003cbr/\u003eoverride any Docker health checks that exist in the container image.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can view the health status of both individual containers and a task with\u003cbr/\u003ethe DescribeTasks API operation or when viewing the task details in the console.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe health check is designed to make sure that your containers survive agent\u003cbr/\u003erestarts, upgrades, or temporary unavailability.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following describes the possible healthStatus values for a container:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HEALTHY-The container health check has passed successfully.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNHEALTHY-The container health check has failed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNKNOWN-The container health check is being evaluated, there\u0026rsquo;s no container\u003cbr/\u003e health check defined, or Amazon ECS doesn\u0026rsquo;t have the health status of\u003cbr/\u003e the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following describes the possible healthStatus values based on the container\u003cbr/\u003ehealth checker status of essential containers in the task with the following\u003cbr/\u003epriority order (high to low):\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNHEALTHY-One or more essential containers have failed their health\u003cbr/\u003e check.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * UNKNOWN-Any essential container running within the task is in an UNKNOWN\u003cbr/\u003e state and no other essential containers have an UNHEALTHY state.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * HEALTHY-All essential containers within the task have passed their health\u003cbr/\u003e checks.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConsider the following task health example with 2 containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, the task health\u003cbr/\u003e is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is HEALTHY, the task health\u003cbr/\u003e is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, the task health\u003cbr/\u003e is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is HEALTHY, the task health\u003cbr/\u003e is HEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConsider the following task health example with 3 containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3\u003cbr/\u003e is UNKNOWN, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is UNKNOWN, and Container3\u003cbr/\u003e is HEALTHY, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is UNHEALTHY and Container2 is HEALTHY, and Container3\u003cbr/\u003e is HEALTHY, the task health is UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is\u003cbr/\u003e HEALTHY, the task health is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is UNKNOWN, and Container3 is\u003cbr/\u003e UNKNOWN, the task health is UNKNOWN.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If Container1 is HEALTHY and Container2 is HEALTHY, and Container3 is\u003cbr/\u003e HEALTHY, the task health is HEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf a task is run manually, and not as part of a service, the task will continue\u003cbr/\u003eits lifecycle regardless of its health status. For tasks that are part of\u003cbr/\u003ea service, if the task reports as unhealthy then the task will be stopped\u003cbr/\u003eand the service scheduler will replace it.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following are notes about container health check support:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * When the Amazon ECS agent cannot connect to the Amazon ECS service,\u003cbr/\u003e the service reports the container as UNHEALTHY.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The health check statuses are the \u0026ldquo;last heard from\u0026rdquo; response from the\u003cbr/\u003e Amazon ECS agent. There are no assumptions made about the status of the\u003cbr/\u003e container health checks.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks require version 1.17.0 or greater of the Amazon\u003cbr/\u003e ECS container agent. For more information, see Updating the Amazon ECS\u003cbr/\u003e container agent (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks are supported for Fargate tasks if you\u0026rsquo;re using\u003cbr/\u003e platform version 1.1.0 or greater. For more information, see Fargate platform\u003cbr/\u003e versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Container health checks aren\u0026rsquo;t supported for tasks that are part of\u003cbr/\u003e a service that\u0026rsquo;s configured to use a Classic Load Balancer. |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.command\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].healthCheck.interval\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.retries\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.startPeriod\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].healthCheck.timeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].hostname\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].image\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].interactive\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].links\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].links.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Linux-specific options that are applied to the container, such as Linux\u003cbr/\u003eKernelCapabilities (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Linux capabilities for the container that are added to or dropped from\u003cbr/\u003ethe default configuration provided by Docker. For more information about\u003cbr/\u003ethe default capabilities and the non-default available capabilities, see\u003cbr/\u003eRuntime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities)\u003cbr/\u003ein the Docker run reference. For more detailed information about these Linux\u003cbr/\u003ecapabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html)\u003cbr/\u003eLinux manual page. |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.add\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.add.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.drop\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.capabilities.drop.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing a container instance host device. || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].hostPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].permissions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.devices.[].permissions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.initProcessEnabled\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.maxSwap\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.sharedMemorySize\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.swappiness\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container path, mount options, and size of the tmpfs mount. || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].mountOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].mountOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003econtainerDefinitions.[].linuxParameters.tmpfs.[].size\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe log configuration for the container. This parameter maps to LogConfig\u003cbr/\u003ein the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\u003cbr/\u003esection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\u003cbr/\u003eand the \u0026ndash;log-driver option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eBy default, containers use the same logging driver that the Docker daemon\u003cbr/\u003euses. However, the container might use a different logging driver than the\u003cbr/\u003eDocker daemon by specifying a log driver configuration in the container definition.\u003cbr/\u003eFor more information about the options for different supported log drivers,\u003cbr/\u003esee Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/)\u003cbr/\u003ein the Docker documentation.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eUnderstand the following when specifying a log configuration for your containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Amazon ECS currently supports a subset of the logging drivers available\u003cbr/\u003e to the Docker daemon. Additional log drivers may be available in future\u003cbr/\u003e releases of the Amazon ECS container agent. For tasks on Fargate, the\u003cbr/\u003e supported log drivers are awslogs, splunk, and awsfirelens. For tasks\u003cbr/\u003e hosted on Amazon EC2 instances, the supported log drivers are awslogs,\u003cbr/\u003e fluentd, gelf, json-file, journald, logentries,syslog, splunk, and awsfirelens.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * This parameter requires version 1.18 of the Docker Remote API or greater\u003cbr/\u003e on your container instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container\u003cbr/\u003e agent must register the available logging drivers with the ECS_AVAILABLE_LOGGING_DRIVERS\u003cbr/\u003e environment variable before containers placed on that instance can use\u003cbr/\u003e these log configuration options. For more information, see Amazon ECS\u003cbr/\u003e container agent configuration (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html)\u003cbr/\u003e in the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that are on Fargate, because you don\u0026rsquo;t have access to the\u003cbr/\u003e underlying infrastructure your tasks are hosted on, any additional software\u003cbr/\u003e needed must be installed outside of the task. For example, the Fluentd\u003cbr/\u003e output aggregators or a remote host running Logstash to send Gelf logs\u003cbr/\u003e to. |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.logDriver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.options\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].logConfiguration.secretOptions.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].memory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].memoryReservation\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe details for a volume mount point that\u0026rsquo;s used in a container definition. || \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].containerPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].readOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].mountPoints.[].sourceVolume\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003ePort mappings allow containers to access ports on the host container instance\nto send or receive traffic. Port mappings are specified as part of the container\ndefinition.\u003c/p\u003e\n\u003cp\u003eIf you use containers in a task with the awsvpc or host network mode, specify\nthe exposed ports using containerPort. The hostPort can be left blank or\nit must be the same value as the containerPort.\u003c/p\u003e\n\u003cp\u003eMost fields of this parameter (containerPort, hostPort, protocol) maps to\nPortBindings in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\nsection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\nand the \u0026ndash;publish option to docker run (https://docs.docker.com/engine/reference/commandline/run/).\nIf the network mode of a task definition is set to host, host ports must\neither be undefined or match the container port in the port mapping.\u003c/p\u003e\n\u003cp\u003eYou can\u0026rsquo;t expose the same container port for multiple protocols. If you attempt\nthis, an error is returned.\u003c/p\u003e\n\u003cp\u003eAfter a task reaches the RUNNING status, manual and automatic host and container\nport assignments are visible in the networkBindings section of DescribeTasks\nAPI responses. || \u003cstrong\u003econtainerDefinitions.[].portMappings.[].appProtocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].containerPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].containerPortRange\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].hostPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].portMappings.[].protocol\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].privileged\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].pseudoTerminal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].readonlyRootFilesystem\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].repositoryCredentials\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe repository credentials for private registry authentication. |\n| \u003cstrong\u003econtainerDefinitions.[].repositoryCredentials.credentialsParameter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe type and amount of a resource to assign to a container. The supported\nresource types are GPUs and Elastic Inference accelerators. For more information,\nsee Working with GPUs on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-gpu.html)\nor Working with Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide || \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].resourceRequirements.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn object representing the secret to expose to your container. Secrets can\nbe exposed to a container in the following ways:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eTo inject sensitive data into your containers as environment variables,\nuse the secrets container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTo reference sensitive information in the log configuration of a container,\nuse the secretOptions container definition parameter.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eFor more information, see Specifying sensitive data (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003econtainerDefinitions.[].secrets.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].secrets.[].valueFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].startTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].stopTimeout\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of namespaced kernel parameters to set in the container. This parameter\nmaps to Sysctls in the Create a container (https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate)\nsection of the Docker Remote API (https://docs.docker.com/engine/api/v1.35/)\nand the \u0026ndash;sysctl option to docker run (https://docs.docker.com/engine/reference/run/#security-configuration).\nFor example, you can configure net.ipv4.tcp_keepalive_time setting to maintain\nlonger lived connections.\u003c/p\u003e\n\u003cp\u003eWe don\u0026rsquo;t recommend that you specify network-related systemControls parameters\nfor multiple containers in a single task that also uses either the awsvpc\nor host network mode. Doing this has the following disadvantages:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the awsvpc network mode including Fargate, if you\nset systemControls for any container, it applies to all containers in\nthe task. If you set different systemControls for multiple containers\nin a single task, the container that\u0026rsquo;s started last determines which systemControls\ntake effect.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the host network mode, the network namespace systemControls\naren\u0026rsquo;t supported.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eIf you\u0026rsquo;re setting an IPC resource namespace to use for the containers in\nthe task, the following conditions apply to your system controls. For more\ninformation, see IPC mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_ipcmode).\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the host IPC mode, IPC namespace systemControls aren\u0026rsquo;t\nsupported.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor tasks that use the task IPC mode, IPC namespace systemControls values\napply to all containers within a task.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003cp\u003eThis parameter is not supported for Windows containers.\u003c/p\u003e\n\u003cp\u003eThis parameter is only supported for tasks that are hosted on Fargate if\nthe tasks are using platform version 1.4.0 or later (Linux). This isn\u0026rsquo;t supported\nfor Windows containers on Fargate. || \u003cstrong\u003econtainerDefinitions.[].systemControls.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].systemControls.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe ulimit settings to pass to the container.\u003c/p\u003e\n\u003cp\u003eAmazon ECS tasks hosted on Fargate use the default resource limit values\nset by the operating system with the exception of the nofile resource limit\nparameter which Fargate overrides. The nofile resource limit sets a restriction\non the number of open files that a container can use. The default nofile\nsoft limit is 1024 and the default hard limit is 65535.\u003c/p\u003e\n\u003cp\u003eYou can specify the ulimit settings for a container in a task definition. || \u003cstrong\u003econtainerDefinitions.[].ulimits.[].hardLimit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].ulimits.[].softLimit\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].user\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on a data volume from another container in the same task definition. || \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[].readOnly\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].volumesFrom.[].sourceContainer\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003econtainerDefinitions.[].workingDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003ecpu\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe number of CPU units used by the task. It can be expressed as an integer\u003cbr/\u003eusing CPU units (for example, 1024) or as a string using vCPUs (for example,\u003cbr/\u003e1 vCPU or 1 vcpu) in a task definition. String values are converted to an\u003cbr/\u003einteger indicating the CPU units when the task definition is registered.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTask-level CPU and memory parameters are ignored for Windows containers.\u003cbr/\u003eWe recommend specifying container-level resources for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re using the EC2 launch type, this field is optional. Supported values\u003cbr/\u003eare between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). If\u003cbr/\u003eyou do not specify a value, the parameter is ignored.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you\u0026rsquo;re using the Fargate launch type, this field is required and you must\u003cbr/\u003euse one of the following values, which determines your range of supported\u003cbr/\u003evalues for the memory parameter:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe CPU units cannot be less than 1 vCPU when you use Windows containers\u003cbr/\u003eon Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB),\u003cbr/\u003e 2048 (2 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072\u003cbr/\u003e (3 GB), 4096 (4 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096\u003cbr/\u003e (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 2048 (2 vCPU) - Available memory values: 4096 (4 GB) and 16384 (16 GB)\u003cbr/\u003e in increments of 1024 (1 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB)\u003cbr/\u003e in increments of 1024 (1 GB)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments\u003cbr/\u003e This option requires Linux platform 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments\u003cbr/\u003e This option requires Linux platform 1.4.0 or later. |\n| \u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe amount of ephemeral storage to allocate for the task. This parameter\u003cbr/\u003eis used to expand the total amount of ephemeral storage available, beyond\u003cbr/\u003ethe default amount, for tasks hosted on Fargate. For more information, see\u003cbr/\u003eUsing data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html)\u003cbr/\u003ein the Amazon ECS Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tasks using the Fargate launch type, the task requires the following\u003cbr/\u003eplatforms:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Linux platform version 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Windows platform version 1.0.0 or later. |\n| \u003cstrong\u003eephemeralStorage.sizeInGiB\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eexecutionRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of the task execution role that grants the\u003cbr/\u003eAmazon ECS container agent permission to make Amazon Web Services API calls\u003cbr/\u003eon your behalf. The task execution IAM role is required depending on the\u003cbr/\u003erequirements of your task. For more information, see Amazon ECS task execution\u003cbr/\u003eIAM role (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003efamily\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eYou must specify a family for a task definition. You can use it track multiple\u003cbr/\u003eversions of the same task definition. The family is used as a name for your\u003cbr/\u003etask definition. Up to 255 letters (uppercase and lowercase), numbers, underscores,\u003cbr/\u003eand hyphens are allowed. |\n| \u003cstrong\u003einferenceAccelerators\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Elastic Inference accelerators to use for the containers in the task. |\n| \u003cstrong\u003einferenceAccelerators.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on an Elastic Inference accelerator. For more information, see Working\nwith Amazon Elastic Inference on Amazon ECS (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-inference.html)\nin the Amazon Elastic Container Service Developer Guide. || \u003cstrong\u003einferenceAccelerators.[].deviceName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003einferenceAccelerators.[].deviceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eipcMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPC resource namespace to use for the containers in the task. The valid\u003cbr/\u003evalues are host, task, or none. If host is specified, then all containers\u003cbr/\u003ewithin the tasks that specified the host IPC mode on the same container instance\u003cbr/\u003eshare the same IPC resources with the host Amazon EC2 instance. If task is\u003cbr/\u003especified, all containers within the specified task share the same IPC resources.\u003cbr/\u003eIf none is specified, then IPC resources within the containers of a task\u003cbr/\u003eare private and not shared with other containers in a task or on the container\u003cbr/\u003einstance. If no value is specified, then the IPC resource namespace sharing\u003cbr/\u003edepends on the Docker daemon setting on the container instance. For more\u003cbr/\u003einformation, see IPC settings (https://docs.docker.com/engine/reference/run/#ipc-settings\u0026mdash;ipc)\u003cbr/\u003ein the Docker run reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the host IPC mode is used, be aware that there is a heightened risk of\u003cbr/\u003eundesired IPC namespace expose. For more information, see Docker security\u003cbr/\u003e(https://docs.docker.com/engine/security/security/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf you are setting namespaced kernel parameters using systemControls for\u003cbr/\u003ethe containers in the task, the following will apply to your IPC resource\u003cbr/\u003enamespace. For more information, see System Controls (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that use the host IPC mode, IPC namespace related systemControls\u003cbr/\u003e are not supported.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For tasks that use the task IPC mode, IPC namespace related systemControls\u003cbr/\u003e will apply to all containers within a task.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for Windows containers or tasks run on Fargate. |\n| \u003cstrong\u003ememory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe amount of memory (in MiB) used by the task. It can be expressed as an\u003cbr/\u003einteger using MiB (for example ,1024) or as a string using GB (for example,\u003cbr/\u003e1GB or 1 GB) in a task definition. String values are converted to an integer\u003cbr/\u003eindicating the MiB when the task definition is registered.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTask-level CPU and memory parameters are ignored for Windows containers.\u003cbr/\u003eWe recommend specifying container-level resources for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf using the EC2 launch type, this field is optional.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf using the Fargate launch type, this field is required and you must use\u003cbr/\u003eone of the following values. This determines your range of supported values\u003cbr/\u003efor the cpu parameter.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe CPU units cannot be less than 1 vCPU when you use Windows containers\u003cbr/\u003eon Fargate.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25\u003cbr/\u003e vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values:\u003cbr/\u003e 512 (.5 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168\u003cbr/\u003e (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) -\u003cbr/\u003e Available cpu values: 2048 (2 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) -\u003cbr/\u003e Available cpu values: 4096 (4 vCPU)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192\u003cbr/\u003e (8 vCPU) This option requires Linux platform 1.4.0 or later.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384\u003cbr/\u003e (16 vCPU) This option requires Linux platform 1.4.0 or later. |\n| \u003cstrong\u003enetworkMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Docker networking mode to use for the containers in the task. The valid\u003cbr/\u003evalues are none, bridge, awsvpc, and host. If no network mode is specified,\u003cbr/\u003ethe default is bridge.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Amazon ECS tasks on Fargate, the awsvpc network mode is required. For\u003cbr/\u003eAmazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used.\u003cbr/\u003eFor Amazon ECS tasks on Amazon EC2 Windows instances, \u003cdefault\u003e or awsvpc\u003cbr/\u003ecan be used. If the network mode is set to none, you cannot specify port\u003cbr/\u003emappings in your container definitions, and the tasks containers do not have\u003cbr/\u003eexternal connectivity. The host and awsvpc network modes offer the highest\u003cbr/\u003enetworking performance for containers because they use the EC2 network stack\u003cbr/\u003einstead of the virtualized network stack provided by the bridge mode.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWith the host and awsvpc network modes, exposed container ports are mapped\u003cbr/\u003edirectly to the corresponding host port (for the host network mode) or the\u003cbr/\u003eattached elastic network interface port (for the awsvpc network mode), so\u003cbr/\u003eyou cannot take advantage of dynamic host port mappings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen using the host network mode, you should not run containers using the\u003cbr/\u003eroot user (UID 0). It is considered best practice to use a non-root user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the network mode is awsvpc, the task is allocated an elastic network interface,\u003cbr/\u003eand you must specify a NetworkConfiguration value when you create a service\u003cbr/\u003eor run a task with the task definition. For more information, see Task Networking\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the network mode is host, you cannot run multiple instantiations of the\u003cbr/\u003esame task on a single container instance when port mappings are used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings)\u003cbr/\u003ein the Docker run reference. |\n| \u003cstrong\u003epidMode\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe process namespace to use for the containers in the task. The valid values\u003cbr/\u003eare host or task. On Fargate for Linux containers, the only valid value is\u003cbr/\u003etask. For example, monitoring sidecars might need pidMode to access information\u003cbr/\u003eabout other containers running in the same task.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf host is specified, all containers within the tasks that specified the\u003cbr/\u003ehost PID mode on the same container instance share the same process namespace\u003cbr/\u003ewith the host Amazon EC2 instance.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf task is specified, all containers within the specified task share the\u003cbr/\u003esame process namespace.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf no value is specified, the default is a private namespace for each container.\u003cbr/\u003eFor more information, see PID settings (https://docs.docker.com/engine/reference/run/#pid-settings\u0026mdash;pid)\u003cbr/\u003ein the Docker run reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf the host PID mode is used, there\u0026rsquo;s a heightened risk of undesired process\u003cbr/\u003enamespace exposure. For more information, see Docker security (https://docs.docker.com/engine/security/security/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is not supported for Windows containers.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is only supported for tasks that are hosted on Fargate if\u003cbr/\u003ethe tasks are using platform version 1.4.0 or later (Linux). This isn\u0026rsquo;t supported\u003cbr/\u003efor Windows containers on Fargate. |\n| \u003cstrong\u003eplacementConstraints\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of placement constraint objects to use for the task. You can specify\u003cbr/\u003ea maximum of 10 constraints for each task. This limit includes constraints\u003cbr/\u003ein the task definition and those specified at runtime. |\n| \u003cstrong\u003eplacementConstraints.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe constraint on task placement in the task definition. For more information,\nsee Task placement constraints (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html)\nin the Amazon Elastic Container Service Developer Guide.\u003c/p\u003e\n\u003cp\u003eTask placement constraints aren\u0026rsquo;t supported for tasks run on Fargate. || \u003cstrong\u003eplacementConstraints.[].expression\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eplacementConstraints.[].type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe configuration details for the App Mesh proxy.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor tasks hosted on Amazon EC2 instances, the container instances require\u003cbr/\u003eat least version 1.26.0 of the container agent and at least version 1.26.0-1\u003cbr/\u003eof the ecs-init package to use a proxy configuration. If your container instances\u003cbr/\u003eare launched from the Amazon ECS-optimized AMI version 20190301 or later,\u003cbr/\u003ethen they contain the required versions of the container agent and ecs-init.\u003cbr/\u003eFor more information, see Amazon ECS-optimized AMI versions (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-ami-versions.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003eproxyConfiguration.containerName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA key-value pair object. || \u003cstrong\u003eproxyConfiguration.properties.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.properties.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eproxyConfiguration.type\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003erequiresCompatibilities\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe task launch type that Amazon ECS validates the task definition against.\u003cbr/\u003eA client exception is returned if the task definition doesn\u0026rsquo;t validate against\u003cbr/\u003ethe compatibilities specified. If no value is specified, the parameter is\u003cbr/\u003eomitted from the response. |\n| \u003cstrong\u003erequiresCompatibilities.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003eruntimePlatform\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe operating system that your tasks definitions run on. A platform family\u003cbr/\u003eis specified only for tasks using the Fargate launch type.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you specify a task definition in a service, this value must match the\u003cbr/\u003eruntimePlatform value of the service. |\n| \u003cstrong\u003eruntimePlatform.cpuArchitecture\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eruntimePlatform.operatingSystemFamily\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to the task definition to help you categorize\u003cbr/\u003eand organize them. Each tag consists of a key and an optional value. You\u003cbr/\u003edefine both of them.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe following basic restrictions apply to tags:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum number of tags per resource - 50\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * For each resource, each tag key must be unique, and each tag key can\u003cbr/\u003e have only one value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum key length - 128 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Maximum value length - 256 Unicode characters in UTF-8\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * If your tagging schema is used across multiple services and resources,\u003cbr/\u003e remember that other services may have restrictions on allowed characters.\u003cbr/\u003e Generally allowed characters are: letters, numbers, and spaces representable\u003cbr/\u003e in UTF-8, and the following characters: + - = . _ : / @.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Tag keys and values are case-sensitive.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Do not use aws:, AWS:, or any upper or lowercase combination of such\u003cbr/\u003e as a prefix for either keys or values as it is reserved for Amazon Web\u003cbr/\u003e Services use. You cannot edit or delete tag keys or values with this prefix.\u003cbr/\u003e Tags with this prefix do not count against your tags per resource limit. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe metadata that you apply to a resource to help you categorize and organize\nthem. Each tag consists of a key and an optional value. You define them.\u003c/p\u003e\n\u003cp\u003eThe following basic restrictions apply to tags:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum number of tags per resource - 50\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eFor each resource, each tag key must be unique, and each tag key can\nhave only one value.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum key length - 128 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eMaximum value length - 256 Unicode characters in UTF-8\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eIf your tagging schema is used across multiple services and resources,\nremember that other services may have restrictions on allowed characters.\nGenerally allowed characters are: letters, numbers, and spaces representable\nin UTF-8, and the following characters: + - = . _ : / @.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eTag keys and values are case-sensitive.\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eDo not use aws:, AWS:, or any upper or lowercase combination of such\nas a prefix for either keys or values as it is reserved for Amazon Web\nServices use. You cannot edit or delete tag keys or values with this prefix.\nTags with this prefix do not count against your tags per resource limit. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etaskRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe short name or full Amazon Resource Name (ARN) of the IAM role that containers\u003cbr/\u003ein this task can assume. All containers in this task are granted the permissions\u003cbr/\u003ethat are specified in this role. For more information, see IAM Roles for\u003cbr/\u003eTasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003etaskRoleRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003etaskRoleRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003etaskRoleRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of volume definitions in JSON format that containers in your task\u003cbr/\u003emight use. |\n| \u003cstrong\u003evolumes.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data volume configuration for tasks launched using this task definition.\nSpecifying a volume configuration in a task definition is optional. The volume\nconfiguration may contain multiple volumes but only one volume configured\nat launch is supported. Each volume defined in the volume configuration may\nonly specify a name and one of either configuredAtLaunch, dockerVolumeConfiguration,\nefsVolumeConfiguration, fsxWindowsFileServerVolumeConfiguration, or host.\nIf an empty volume configuration is specified, by default Amazon ECS uses\na host volume. For more information, see Using data volumes in tasks (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html). || \u003cstrong\u003evolumes.[].configuredAtLaunch\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using Docker volumes. Docker volumes\u003cbr/\u003eare only supported when you\u0026rsquo;re using the EC2 launch type. Windows containers\u003cbr/\u003eonly support the use of the local driver. To use bind mounts, specify a host\u003cbr/\u003einstead. |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.autoprovision\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.driver\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.driverOpts\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.labels\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].dockerVolumeConfiguration.scope\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using an Amazon Elastic File System\u003cbr/\u003efile system for task storage. For more information, see Amazon EFS volumes\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe authorization configuration details for the Amazon EFS file system. |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig.accessPointID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.authorizationConfig.iam\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.rootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.transitEncryption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].efsVolumeConfiguration.transitEncryptionPort\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThis parameter is specified when you\u0026rsquo;re using Amazon FSx for Windows File\u003cbr/\u003eServer (https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html)\u003cbr/\u003efile system for task storage.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information and the input format, see Amazon FSx for Windows File\u003cbr/\u003eServer volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe authorization configuration details for Amazon FSx for Windows File Server\u003cbr/\u003efile system. See FSxWindowsFileServerVolumeConfiguration (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FSxWindowsFileServerVolumeConfiguration.html)\u003cbr/\u003ein the Amazon ECS API Reference.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information and the input format, see Amazon FSx for Windows File\u003cbr/\u003eServer Volumes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide. |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig.credentialsParameter\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.authorizationConfig.domain\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].fsxWindowsFileServerVolumeConfiguration.rootDirectory\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].host\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails on a container instance bind mount host volume. |\n| \u003cstrong\u003evolumes.[].host.sourcePath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evolumes.[].name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncompatibilities:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nderegisteredAt: string\nregisteredAt: string\nregisteredBy: string\nrequiresAttributes:\n- name: string\n targetID: string\n targetType: string\n value: string\nrevision: integer\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibilities\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe task launch types the task definition validated against during task definition\u003cbr/\u003eregistration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecompatibilities.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ederegisteredAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the task definition was deregistered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredAt\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Unix timestamp for the time when the task definition was registered.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eregisteredBy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe principal that registered the task definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe container instance attributes required by your task. When an Amazon EC2\u003cbr/\u003einstance is registered to your cluster, the Amazon ECS container agent assigns\u003cbr/\u003esome standard attributes to the instance. You can apply custom attributes.\u003cbr/\u003eThese are specified as key-value pairs using the Amazon ECS console or the\u003cbr/\u003ePutAttributes API. These attributes are used when determining task placement\u003cbr/\u003efor tasks hosted on Amazon EC2 instances. For more information, see Attributes\u003cbr/\u003e(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)\u003cbr/\u003ein the Amazon Elastic Container Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter isn\u0026rsquo;t supported for tasks run on Fargate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn attribute is a name-value pair that\u0026rsquo;s associated with an Amazon ECS object.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse attributes to extend the Amazon ECS data model by adding custom metadata\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eto your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ein the Amazon Elastic Container Service Developer Guide.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].targetID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].targetType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequiresAttributes.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevision\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe revision of the task in a particular family. The revision is a version\u003cbr/\u003enumber of a task definition in a family. When you register a task definition\u003cbr/\u003efor the first time, the revision is 1. Each time that you register a new\u003cbr/\u003erevision of a task definition in the same family, the revision value always\u003cbr/\u003eincreases by one. This is even if you deregistered previous revisions in\u003cbr/\u003ethis family.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the task definition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:179,href:"https://aws-controllers-k8s.github.io/community/reference/sns/v1alpha1/topic/",title:"Topic",description:null,content:'\u003cp\u003e\u003ccode\u003esns.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sns-controller/apis/v1alpha1#Topic"\u003esns-controller/apis/v1alpha1#Topic\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTopic\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTopicList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etopics\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etopic\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA wrapper type for the topic\u0026rsquo;s Amazon Resource Name (ARN). To retrieve a\ntopic\u0026rsquo;s attributes, use GetTopicAttributes.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtentBasedDeduplication: string\ndataProtectionPolicy: string\ndeliveryPolicy: string\ndisplayName: string\nfifoTopic: string\nkmsMasterKeyID: string\nkmsMasterKeyRef: \n from: \n name: string\nname: string\npolicy: string\npolicyRef: \n from: \n name: string\nsignatureVersion: string\ntags:\n- key: string\n value: string\ntracingConfig: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtentBasedDeduplication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProtectionPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe body of the policy document you want to use for this topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can only add one policy per topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe policy must be in JSON string format.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eLength Constraints: Maximum length of 30,720.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efifoTopic\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsMasterKeyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the topic you want to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eConstraints: Topic names must be made up of only uppercase and lowercase\u003cbr/\u003eASCII letters, numbers, underscores, and hyphens, and must be between 1 and\u003cbr/\u003e256 characters long.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esignatureVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of tags to add to a new topic.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to tag a topic on creation, you must have the sns:CreateTopic\u003cbr/\u003eand sns:TagResource permissions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe list of tags to be added to the specified topic.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\neffectiveDeliveryPolicy: string\nowner: string\ntopicARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eeffectiveDeliveryPolicy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eowner\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:180,href:"https://aws-controllers-k8s.github.io/community/reference/cloudtrail/v1alpha1/trail/",title:"Trail",description:null,content:'\u003cp\u003e\u003ccode\u003ecloudtrail.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/cloudtrail-controller/apis/v1alpha1#Trail"\u003ecloudtrail-controller/apis/v1alpha1#Trail\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrail\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrailList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrails\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrail\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThe settings for a trail.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecloudWatchLogsLogGroupARN: string\ncloudWatchLogsRoleARN: string\nenableLogFileValidation: boolean\nincludeGlobalServiceEvents: boolean\nisMultiRegionTrail: boolean\nisOrganizationTrail: boolean\nkmsKeyID: string\nname: string\ns3BucketName: string\ns3KeyPrefix: string\nsnsTopicName: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudWatchLogsLogGroupARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies a log group name using an Amazon Resource Name (ARN), a unique\u003cbr/\u003eidentifier that represents the log group to which CloudTrail logs will be\u003cbr/\u003edelivered. Not required unless you specify CloudWatchLogsRoleArn.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecloudWatchLogsRoleARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the role for the CloudWatch Logs endpoint to assume to write to\u003cbr/\u003ea user\u0026rsquo;s log group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableLogFileValidation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether log file integrity validation is enabled. The default is\u003cbr/\u003efalse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWhen you disable log file integrity validation, the chain of digest files\u003cbr/\u003eis broken after one hour. CloudTrail does not create digest files for log\u003cbr/\u003efiles that were delivered during a period in which log file integrity validation\u003cbr/\u003ewas disabled. For example, if you enable log file integrity validation at\u003cbr/\u003enoon on January 1, disable it at noon on January 2, and re-enable it at noon\u003cbr/\u003eon January 10, digest files will not be created for the log files delivered\u003cbr/\u003efrom noon on January 2 to noon on January 10. The same applies whenever you\u003cbr/\u003estop CloudTrail logging or delete a trail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eincludeGlobalServiceEvents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is publishing events from global services such\u003cbr/\u003eas IAM to the log files.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisMultiRegionTrail\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is created in the current region or in all regions.\u003cbr/\u003eThe default is false, which creates a trail only in the region where you\u003cbr/\u003eare signed in. As a best practice, consider creating trails that log events\u003cbr/\u003ein all regions.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisOrganizationTrail\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether the trail is created for all accounts in an organization\u003cbr/\u003ein Organizations, or only for the current Amazon Web Services account. The\u003cbr/\u003edefault is false, and cannot be true unless the call is made on behalf of\u003cbr/\u003ean Amazon Web Services account that is the management account for an organization\u003cbr/\u003ein Organizations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the KMS key ID to use to encrypt the logs delivered by CloudTrail.\u003cbr/\u003eThe value can be an alias name prefixed by \u0026ldquo;alias/\u0026rdquo;, a fully specified ARN\u003cbr/\u003eto an alias, a fully specified ARN to a key, or a globally unique identifier.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCloudTrail also supports KMS multi-Region keys. For more information about\u003cbr/\u003emulti-Region keys, see Using multi-Region keys (https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html)\u003cbr/\u003ein the Key Management Service Developer Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eExamples:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * alias/MyAliasName\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:kms:us-east-2:123456789012:alias/MyAliasName\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * 12345678-1234-1234-1234-123456789012\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the trail. The name must meet the following requirements:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores\u003cbr/\u003e (_), or dashes (-)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Start with a letter or number, and end with a letter or number\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Be between 3 and 128 characters\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Have no adjacent periods, underscores or dashes. Names like my-_namespace\u003cbr/\u003e and my\u0026ndash;namespace are not valid.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Not be in IP address format (for example, 192.168.5.4)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003es3BucketName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the Amazon S3 bucket designated for publishing log\u003cbr/\u003efiles. See Amazon S3 Bucket Naming Requirements (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003es3KeyPrefix\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the Amazon S3 key prefix that comes after the name of the bucket\u003cbr/\u003eyou have designated for log file delivery. For more information, see Finding\u003cbr/\u003eYour CloudTrail Log Files (https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).\u003cbr/\u003eThe maximum length is 200 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the name of the Amazon SNS topic defined for notification of log\u003cbr/\u003efile delivery. The maximum length is 256 characters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom key-value pair associated with a resource such as a CloudTrail trail.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nlogFileValidationEnabled: boolean\nsnsTopicARN: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elogFileValidationEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eSpecifies whether log file integrity validation is enabled.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnsTopicARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications\u003cbr/\u003ewhen log files are delivered. The format of a topic ARN is:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003earn:aws:sns:us-east-2:123456789012:MyTopic\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:181,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/trainingjob/",title:"TrainingJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#TrainingJob"\u003esagemaker-controller/apis/v1alpha1#TrainingJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrainingJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTrainingJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrainingjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etrainingjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about a training job.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealgorithmSpecification: \n algorithmName: string\n enableSageMakerMetricsTimeSeries: boolean\n metricDefinitions:\n - name: string\n regex: string\n trainingImage: string\n trainingInputMode: string\ncheckpointConfig: \n localPath: string\n s3URI: string\ndebugHookConfig: \n collectionConfigurations:\n - collectionName: string\n collectionParameters: {}\n hookParameters: {}\n localPath: string\n s3OutputPath: string\ndebugRuleConfigurations:\n- instanceType: string\n localPath: string\n ruleConfigurationName: string\n ruleEvaluatorImage: string\n ruleParameters: {}\n s3OutputPath: string\n volumeSizeInGB: integer\nenableInterContainerTrafficEncryption: boolean\nenableManagedSpotTraining: boolean\nenableNetworkIsolation: boolean\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nhyperParameters: {}\ninfraCheckConfig: \n enableInfraCheck: boolean\ninputDataConfig:\n- channelName: string\n compressionType: string\n contentType: string\n dataSource: \n fileSystemDataSource: \n directoryPath: string\n fileSystemAccessMode: string\n fileSystemID: string\n fileSystemType: string\n s3DataSource: \n attributeNames:\n - string\n instanceGroupNames:\n - string\n s3DataDistributionType: string\n s3DataType: string\n s3URI: string\n inputMode: string\n recordWrapperType: string\n shuffleConfig: \n seed: integer\noutputDataConfig: \n compressionType: string\n kmsKeyID: string\n s3OutputPath: string\nprofilerConfig: \n profilingIntervalInMilliseconds: integer\n profilingParameters: {}\n s3OutputPath: string\nprofilerRuleConfigurations:\n- instanceType: string\n localPath: string\n ruleConfigurationName: string\n ruleEvaluatorImage: string\n ruleParameters: {}\n s3OutputPath: string\n volumeSizeInGB: integer\nremoteDebugConfig: \n enableRemoteDebug: boolean\nresourceConfig: \n instanceCount: integer\n instanceGroups:\n - instanceCount: integer\n instanceGroupName: string\n instanceType: string\n instanceType: string\n keepAlivePeriodInSeconds: integer\n volumeKMSKeyID: string\n volumeSizeInGB: integer\nretryStrategy: \n maximumRetryAttempts: integer\nroleARN: string\nstoppingCondition: \n maxPendingTimeInSeconds: integer\n maxRuntimeInSeconds: integer\n maxWaitTimeInSeconds: integer\ntags:\n- key: string\n value: string\ntensorBoardOutputConfig: \n localPath: string\n s3OutputPath: string\ntrainingJobName: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnets:\n - string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe registry path of the Docker image that contains the training algorithm\u003cbr/\u003eand algorithm-specific metadata, including the input mode. For more information\u003cbr/\u003eabout algorithms provided by SageMaker, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003eFor information about providing your own algorithms, see Using Your Own Algorithms\u003cbr/\u003ewith Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.algorithmName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.enableSageMakerMetricsTimeSeries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a metric that the training algorithm writes to stderr or stdout.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eYou can view these logs to understand how your training job performs and\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003echeck for any errors encountered during training. SageMaker hyperparameter\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etuning captures all defined metrics. Specify one of the defined metrics to\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003euse as an objective metric using the TuningObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTrainingJobDefinition.html#sagemaker-Type-HyperParameterTrainingJobDefinition-TuningObjective)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eparameter in the HyperParameterTrainingJobDefinition API to evaluate job\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eperformance during hyperparameter tuning.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.metricDefinitions.[].regex\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.trainingImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealgorithmSpecification.trainingInputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the output location for managed spot training\u003cbr/\u003echeckpoint data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003echeckpointConfig.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for the Amazon SageMaker Debugger hook parameters,\u003cbr/\u003emetric and tensor collections, and storage paths. To learn more about how\u003cbr/\u003eto configure the DebugHookConfig parameter, see Use the SageMaker and Debugger\u003cbr/\u003eConfiguration API Operations to Create, Update, and Debug Your Training Job\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for the Amazon SageMaker Debugger output tensor\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ecollections.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.collectionConfigurations.[].collectionParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.hookParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugHookConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger rules for debugging\u003cbr/\u003eoutput tensors.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for SageMaker Debugger rules for debugging. To\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003elearn more about how to configure the DebugRuleConfiguration parameter, see\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eUse the SageMaker and Debugger Configuration API Operations to Create, Update,\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eand Debug Your Training Job (https://docs.aws.amazon.com/sagemaker/latest/dg/debugger-createtrainingjob-api.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleEvaluatorImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].ruleParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleConfigurations.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableInterContainerTrafficEncryption\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTo encrypt all communications between ML compute instances in distributed\u003cbr/\u003etraining, choose True. Encryption provides greater security for distributed\u003cbr/\u003etraining, but training might take longer. How long it takes depends on the\u003cbr/\u003eamount of communication between compute instances, especially if you use\u003cbr/\u003ea deep learning algorithm in distributed training. For more information,\u003cbr/\u003esee Protect Communications Between ML Compute Instances in a Distributed\u003cbr/\u003eTraining Job (https://docs.aws.amazon.com/sagemaker/latest/dg/train-encrypt.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableManagedSpotTraining\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eTo train models using managed spot training, choose True. Managed spot training\u003cbr/\u003eprovides a fully managed and scalable infrastructure for training machine\u003cbr/\u003elearning models. this option is useful when training jobs can be interrupted\u003cbr/\u003eand when there is flexibility when the training job is run.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe complete and intermediate results of jobs are stored in an Amazon S3\u003cbr/\u003ebucket, and can be used as a starting point to train models incrementally.\u003cbr/\u003eAmazon SageMaker provides metrics and logs in CloudWatch. They can be used\u003cbr/\u003eto see when managed spot training jobs are running, interrupted, resumed,\u003cbr/\u003eor completed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableNetworkIsolation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIsolates the training container. No inbound or outbound network calls can\u003cbr/\u003ebe made, except for calls between peers within a training cluster for distributed\u003cbr/\u003etraining. If you enable network isolation for training jobs that are configured\u003cbr/\u003eto use a VPC, SageMaker downloads and uploads customer data and model artifacts\u003cbr/\u003ethrough the specified VPC, but the training container does not have network\u003cbr/\u003eaccess.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehyperParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAlgorithm-specific parameters that influence the quality of the model. You\u003cbr/\u003eset hyperparameters before you start the learning process. For a list of\u003cbr/\u003ehyperparameters for each training algorithm provided by SageMaker, see Algorithms\u003cbr/\u003e(https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou can specify a maximum of 100 hyperparameters. Each hyperparameter is\u003cbr/\u003ea key-value pair. Each key and value is limited to 256 characters, as specified\u003cbr/\u003eby the Length Constraint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDo not include any security-sensitive information including account access\u003cbr/\u003eIDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive\u003cbr/\u003ecredentials are detected, SageMaker will reject your training job request\u003cbr/\u003eand return an exception error.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einfraCheckConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eContains information about the infrastructure health check configuration\u003cbr/\u003efor the training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einfraCheckConfig.enableInfraCheck\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of Channel objects. Each channel is a named input source. InputDataConfig\u003cbr/\u003edescribes the input data and its location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eAlgorithms can accept input data from one or more channels. For example,\u003cbr/\u003ean algorithm might have two channels of input data, training_data and validation_data.\u003cbr/\u003eThe configuration for each channel provides the S3, EFS, or FSx location\u003cbr/\u003ewhere the input data is stored. It also provides information about the stored\u003cbr/\u003edata: the MIME type, compression method, and whether the data is wrapped\u003cbr/\u003ein RecordIO format.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDepending on the input mode that the algorithm supports, SageMaker either\u003cbr/\u003ecopies input data files from an S3 bucket to a local directory in the Docker\u003cbr/\u003econtainer, or makes it available as input streams. For example, if you specify\u003cbr/\u003ean EFS location, input data files are available as input streams. They do\u003cbr/\u003enot need to be downloaded.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input must be in the same Amazon Web Services region as your training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA channel is a named input source that training algorithms can consume.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].contentType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a file system data source for a channel.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.directoryPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemAccessMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.fileSystemDataSource.fileSystemType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYour input bucket must be in the same Amazon Web Services region as your\u003cbr/\u003etraining job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.attributeNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.attributeNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.instanceGroupNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].inputMode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe training input mode that the algorithm supports. For more information\u003cbr/\u003eabout input modes, see Algorithms (https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003ePipe mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports Pipe mode, Amazon SageMaker streams data directly\u003cbr/\u003efrom Amazon S3 to the container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports File mode, SageMaker downloads the training data\u003cbr/\u003efrom S3 to the provisioned ML storage volume, and mounts the directory to\u003cbr/\u003ethe Docker volume for the training container.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must provision the ML storage volume with sufficient capacity to accommodate\u003cbr/\u003ethe data downloaded from S3. In addition to the training data, the ML storage\u003cbr/\u003evolume also stores the output model. The algorithm container uses the ML\u003cbr/\u003estorage volume to also store intermediate information, if any.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor distributed algorithms, training data is distributed uniformly. Your\u003cbr/\u003etraining duration is predictable if the input data objects sizes are approximately\u003cbr/\u003ethe same. SageMaker does not split the files any further for model training.\u003cbr/\u003eIf the object sizes are skewed, training won\u0026rsquo;t be optimal as the data distribution\u003cbr/\u003eis also skewed when one host in a training cluster is overloaded, thus becoming\u003cbr/\u003ea bottleneck in training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf an algorithm supports FastFile mode, SageMaker streams data directly from\u003cbr/\u003eS3 to the container with no code changes, and provides file system access\u003cbr/\u003eto the data. Users can author their training script to interact with these\u003cbr/\u003efiles as if they were stored on disk.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFastFile mode works best when the data is read sequentially. Augmented manifest\u003cbr/\u003efiles aren\u0026rsquo;t supported. The startup time is lower when there are fewer files\u003cbr/\u003ein the S3 bucket provided.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].recordWrapperType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].shuffleConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration for a shuffle option for input data in a channel. If you\u003cbr/\u003euse S3Prefix for S3DataType, the results of the S3 key prefix matches are\u003cbr/\u003eshuffled. If you use ManifestFile, the order of the S3 object references\u003cbr/\u003ein the ManifestFile is shuffled. If you use AugmentedManifestFile, the order\u003cbr/\u003eof the JSON lines in the AugmentedManifestFile is shuffled. The shuffling\u003cbr/\u003eorder is determined using the Seed value.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor Pipe input mode, when ShuffleConfig is specified shuffling is done at\u003cbr/\u003ethe start of every epoch. With large datasets, this ensures that the order\u003cbr/\u003eof the training data is different for each epoch, and it helps reduce bias\u003cbr/\u003eand possible overfitting. In a multi-node training job when ShuffleConfig\u003cbr/\u003eis combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled\u003cbr/\u003eacross nodes so that the content sent to a particular node on the first epoch\u003cbr/\u003emight be sent to a different node on the second epoch.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einputDataConfig.[].shuffleConfig.seed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the path to the S3 location where you want to store model artifacts.\u003cbr/\u003eSageMaker creates subfolders for the artifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoutputDataConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger system monitoring,\u003cbr/\u003eframework profiling, and storage paths.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.profilingIntervalInMilliseconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.profilingParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConfiguration information for Amazon SageMaker Debugger rules for profiling\u003cbr/\u003esystem and framework metrics.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration information for profiling rules.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].localPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleEvaluatorImage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].ruleParameters\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleConfigurations.[].volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteDebugConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration for remote debugging. To learn more about the remote debugging\u003cbr/\u003efunctionality of SageMaker, see Access a training container through Amazon\u003cbr/\u003eWeb Services Systems Manager (SSM) for remote debugging (https://docs.aws.amazon.com/sagemaker/latest/dg/train-remote-debugging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eremoteDebugConfig.enableRemoteDebug\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe resources, including the ML compute instances and ML storage volumes,\u003cbr/\u003eto use for model training.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eML storage volumes store model artifacts and incremental states. Training\u003cbr/\u003ealgorithms might also use ML storage volumes for scratch space. If you want\u003cbr/\u003eSageMaker to use the ML storage volume to store the training data, choose\u003cbr/\u003eFile as the TrainingInputMode in the algorithm specification. For distributed\u003cbr/\u003etraining algorithms, specify an instance count greater than 1.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDefines an instance group for heterogeneous cluster training. When requesting\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ea training job using the CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPI, you can configure multiple instance groups .\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[].instanceGroupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceGroups.[].instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.keepAlivePeriodInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Customer requested period in seconds for which the Training cluster\u003cbr/\u003eis kept alive after the job is finished.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eresourceConfig.volumeSizeInGB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretryStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe number of times to retry the job when the job fails due to an InternalServerError.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eretryStrategy.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eroleARN\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to\u003cbr/\u003eperform tasks on your behalf.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDuring model training, SageMaker needs your permission to read input data\u003cbr/\u003efrom an S3 bucket, download a Docker image that contains training code, write\u003cbr/\u003emodel artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and\u003cbr/\u003epublish metrics to Amazon CloudWatch. You grant permissions for all of these\u003cbr/\u003etasks to an IAM role. For more information, see SageMaker Roles (https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-roles.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo be able to pass this role to SageMaker, the caller of this API must have\u003cbr/\u003ethe iam:PassRole permission.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies a limit to how long a model training job can run. It also specifies\u003cbr/\u003ehow long a managed Spot training job has to complete. When the job reaches\u003cbr/\u003ethe time limit, SageMaker ends the training job. Use this API to cap model\u003cbr/\u003etraining costs.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo stop a job, SageMaker sends the algorithm the SIGTERM signal, which delays\u003cbr/\u003ejob termination for 120 seconds. Algorithms can use this 120-second window\u003cbr/\u003eto save the model artifacts, so the results of training are not lost.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxPendingTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eMaximum job scheduler pending time in seconds.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxRuntimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estoppingCondition.maxWaitTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAn array of key-value pairs. You can use tags to categorize your Amazon Web\u003cbr/\u003eServices resources in different ways, for example, by purpose, owner, or\u003cbr/\u003eenvironment. For more information, see Tagging Amazon Web Services Resources\u003cbr/\u003e(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etensorBoardOutputConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration of storage locations for the Amazon SageMaker Debugger TensorBoard\u003cbr/\u003eoutput data. |\n| \u003cstrong\u003etensorBoardOutputConfig.localPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etensorBoardOutputConfig.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etrainingJobName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the training job. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. |\n| \u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA VpcConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html)\u003cbr/\u003eobject that specifies the VPC that you want your training job to connect\u003cbr/\u003eto. Control access to and from your training container by configuring the\u003cbr/\u003eVPC. For more information, see Protect Training Jobs by Using an Amazon Virtual\u003cbr/\u003ePrivate Cloud (https://docs.aws.amazon.com/sagemaker/latest/dg/train-vpc.html). |\n| \u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003evpcConfig.subnets\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcConfig.subnets.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\ndebugRuleEvaluationStatuses:\n- lastModifiedTime: string\n ruleConfigurationName: string\n ruleEvaluationJobARN: string\n ruleEvaluationStatus: string\n statusDetails: string\nfailureReason: string\nlastModifiedTime: string\nmodelArtifacts: \n s3ModelArtifacts: string\nprofilerRuleEvaluationStatuses:\n- lastModifiedTime: string\n ruleConfigurationName: string\n ruleEvaluationJobARN: string\n ruleEvaluationStatus: string\n statusDetails: string\nprofilingStatus: string\nsecondaryStatus: string\ntrainingJobStatus: string\nwarmPoolStatus: \n resourceRetainedBillableTimeInSeconds: integer\n reusedByJob: string\n status: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that indicates when the training job was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEvaluation status of Amazon SageMaker Debugger rules for debugging on a training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the status of the rule evaluation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleEvaluationJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].ruleEvaluationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edebugRuleEvaluationStatuses.[].statusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the training job failed, the reason it failed.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModifiedTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA timestamp that indicates when the status of the training job was last modified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelArtifacts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the Amazon S3 location that is configured for storing model\u003cbr/\u003eartifacts.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelArtifacts.s3ModelArtifacts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEvaluation status of Amazon SageMaker Debugger rules for profiling on a training\u003cbr/\u003ejob.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the status of the rule evaluation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleConfigurationName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleEvaluationJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].ruleEvaluationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilerRuleEvaluationStatuses.[].statusDetails\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprofilingStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProfiling status of a training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecondaryStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eProvides detailed information about the state of the training job. For detailed\u003cbr/\u003einformation on the secondary status of the training job, see StatusMessage\u003cbr/\u003eunder SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSageMaker provides primary statuses and secondary statuses that apply to\u003cbr/\u003eeach of them:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eInProgress\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Starting - Starting the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Downloading - An optional stage for algorithms that support File training\u003cbr/\u003e input mode. It indicates that data is being downloaded to the ML storage\u003cbr/\u003e volumes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Training - Training is in progress.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Interrupted - The job stopped because the managed spot training instances\u003cbr/\u003e were interrupted.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Uploading - Training is complete and the model artifacts are being uploaded\u003cbr/\u003e to the S3 location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eCompleted\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Completed - The training job has completed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFailed\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed - The training job has failed. The reason for the failure is\u003cbr/\u003e returned in the FailureReason field of DescribeTrainingJobResponse.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStopped\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * MaxRuntimeExceeded - The job stopped because it exceeded the maximum\u003cbr/\u003e allowed runtime.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * MaxWaitTimeExceeded - The job stopped because it exceeded the maximum\u003cbr/\u003e allowed wait time.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopped - The training job has stopped.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eStopping\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopping - Stopping the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eValid values for SecondaryStatus are subject to change.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eWe no longer support the following secondary statuses:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * LaunchingMLInstances\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * PreparingTraining\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * DownloadingTrainingImage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etrainingJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the training job.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eSageMaker provides the following training job statuses:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * InProgress - The training is in progress.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Completed - The training job has completed.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Failed - The training job has failed. To see the reason for the failure,\u003cbr/\u003e see the FailureReason field in the response to a DescribeTrainingJobResponse\u003cbr/\u003e call.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopping - The training job is stopping.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Stopped - The training job has stopped.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more detailed information, see SecondaryStatus.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the warm pool associated with the training job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.resourceRetainedBillableTimeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eOptional. Indicates how many seconds the resource stayed in ResourceRetained\u003cbr/\u003estate. Populated only after resource reaches ResourceReused or ResourceReleased\u003cbr/\u003estate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.reusedByJob\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ewarmPoolStatus.status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:182,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/transformjob/",title:"TransformJob",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#TransformJob"\u003esagemaker-controller/apis/v1alpha1#TransformJob\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransformJob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransformJobList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransformjobs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransformjob\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eA batch transform job. For information about SageMaker batch transform, see\nUse Batch Transform (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform.html).\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ebatchStrategy: string\ndataProcessing: \n inputFilter: string\n joinSource: string\n outputFilter: string\nenvironment: {}\nexperimentConfig: \n experimentName: string\n trialComponentDisplayName: string\n trialName: string\nmaxConcurrentTransforms: integer\nmaxPayloadInMB: integer\nmodelClientConfig: \n invocationsMaxRetries: integer\n invocationsTimeoutInSeconds: integer\nmodelName: string\ntags:\n- key: string\n value: string\ntransformInput: \n compressionType: string\n contentType: string\n dataSource: \n s3DataSource: \n s3DataType: string\n s3URI: string\n splitType: string\ntransformJobName: string\ntransformOutput: \n accept: string\n assembleWith: string\n kmsKeyID: string\n s3OutputPath: string\ntransformResources: \n instanceCount: integer\n instanceType: string\n volumeKMSKeyID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebatchStrategy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eSpecifies the number of records to include in a mini-batch for an HTTP inference\u003cbr/\u003erequest. A record is a single unit of input data that inference can be made\u003cbr/\u003eon. For example, a single line in a CSV file is a record.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo enable the batch strategy, you must set the SplitType property to Line,\u003cbr/\u003eRecordIO, or TFRecord.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use only one record when making an HTTP invocation request to a container,\u003cbr/\u003eset BatchStrategy to SingleRecord and SplitType to Line.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo fit as many records in a mini-batch as can fit within the MaxPayloadInMB\u003cbr/\u003elimit, set BatchStrategy to MultiRecord and SplitType to Line.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe data structure used to specify the data to be used for inference in a\u003cbr/\u003ebatch transform job and to associate the data that is relevant to the prediction\u003cbr/\u003eresults in the output. The input filter provided allows you to exclude input\u003cbr/\u003edata that is not needed for inference in a batch transform job. The output\u003cbr/\u003efilter provided allows you to include input data relevant to interpreting\u003cbr/\u003ethe predictions in the output from the job. For more information, see Associate\u003cbr/\u003ePrediction Results with their Corresponding Input Records (https://docs.aws.amazon.com/sagemaker/latest/dg/batch-transform-data-processing.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.inputFilter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.joinSource\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edataProcessing.outputFilter\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe environment variables to set in the Docker container. We support up to\u003cbr/\u003e16 key and values entries in the map.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAssociates a SageMaker job as a trial component with an experiment and trial.\u003cbr/\u003eSpecified when you call the following APIs:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateProcessingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateProcessingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTrainingJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html)\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * CreateTransformJob (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTransformJob.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.experimentName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialComponentDisplayName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexperimentConfig.trialName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxConcurrentTransforms\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum number of parallel requests that can be sent to each instance\u003cbr/\u003ein a transform job. If MaxConcurrentTransforms is set to 0 or left unset,\u003cbr/\u003eAmazon SageMaker checks the optional execution-parameters to determine the\u003cbr/\u003esettings for your chosen algorithm. If the execution-parameters endpoint\u003cbr/\u003eis not enabled, the default value is 1. For more information on execution-parameters,\u003cbr/\u003esee How Containers Serve Requests (https://docs.aws.amazon.com/sagemaker/latest/dg/your-algorithms-batch-code.html#your-algorithms-batch-code-how-containe-serves-requests).\u003cbr/\u003eFor built-in algorithms, you don\u0026rsquo;t need to set a value for MaxConcurrentTransforms.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emaxPayloadInMB\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe maximum allowed size of the payload, in MB. A payload is the data portion\u003cbr/\u003eof a record (without metadata). The value in MaxPayloadInMB must be greater\u003cbr/\u003ethan, or equal to, the size of a single record. To estimate the size of a\u003cbr/\u003erecord in MB, divide the size of your dataset by the number of records. To\u003cbr/\u003eensure that the records fit within the maximum payload size, we recommend\u003cbr/\u003eusing a slightly larger value. The default value is 6 MB.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe value of MaxPayloadInMB cannot be greater than 100 MB. If you specify\u003cbr/\u003ethe MaxConcurrentTransforms parameter, the value of (MaxConcurrentTransforms\u003cbr/\u003e* MaxPayloadInMB) also cannot exceed 100 MB.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor cases where the payload might be arbitrarily large and is transmitted\u003cbr/\u003eusing HTTP chunked encoding, set the value to 0. This feature works only\u003cbr/\u003ein supported algorithms. Currently, Amazon SageMaker built-in algorithms\u003cbr/\u003edo not support HTTP chunked encoding.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfigures the timeout and maximum number of retries for processing a transform\u003cbr/\u003ejob invocation.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig.invocationsMaxRetries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelClientConfig.invocationsTimeoutInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emodelName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the model that you want to use for the transform job. ModelName\u003cbr/\u003emust be the name of an existing Amazon SageMaker model within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Optional) An array of key-value pairs. For more information, see Using Cost\u003cbr/\u003eAllocation Tags (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html#allocation-what)\u003cbr/\u003ein the Amazon Web Services Billing and Cost Management User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the input source and the way the transform job consumes it. |\n| \u003cstrong\u003etransformInput.compressionType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.contentType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.dataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the location of the channel data. |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the S3 data source. |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource.s3DataType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.dataSource.s3DataSource.s3URI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformInput.splitType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformJobName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the transform job. The name must be unique within an Amazon Web\u003cbr/\u003eServices Region in an Amazon Web Services account. |\n| \u003cstrong\u003etransformOutput\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the results of the transform job. |\n| \u003cstrong\u003etransformOutput.accept\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.assembleWith\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.kmsKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformOutput.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the resources, including ML instance types and ML instance count,\u003cbr/\u003eto use for the transform job. |\n| \u003cstrong\u003etransformResources.instanceCount\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etransformResources.volumeKMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nfailureReason: string\ntransformJobStatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efailureReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIf the transform job failed, FailureReason describes why it failed. A transform\u003cbr/\u003ejob creates a log file, which includes error messages, and stores it as an\u003cbr/\u003eAmazon S3 object. For more information, see Log Amazon SageMaker Events with\u003cbr/\u003eAmazon CloudWatch (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransformJobStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the transform job. If the transform job failed, the reason\u003cbr/\u003eis returned in the FailureReason field.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:183,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/transitgateway/",title:"TransitGateway",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#TransitGateway"\u003eec2-controller/apis/v1alpha1#TransitGateway\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransitGateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eTransitGatewayList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransitgateways\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003etransitgateway\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a transit gateway.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edescription: string\noptions: \n amazonSideASN: integer\n autoAcceptSharedAttachments: string\n defaultRouteTableAssociation: string\n defaultRouteTablePropagation: string\n dnsSupport: string\n multicastSupport: string\n transitGatewayCIDRBlocks:\n - string\n vpnECMPSupport: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe transit gateway options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.amazonSideASN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.autoAcceptSharedAttachments\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.defaultRouteTableAssociation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.defaultRouteTablePropagation\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.dnsSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.multicastSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.transitGatewayCIDRBlocks\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eoptions.transitGatewayCIDRBlocks.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTime: string\nownerID: string\nstate: string\ntransitGatewayID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe creation time.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etransitGatewayID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the transit gateway.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:184,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#User"\u003eelasticache-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessString: string\nengine: string\nnoPasswordRequired: boolean\npasswords:\n- key: string\n name: string\n namespace: string\ntags:\n- key: string\n value: string\nuserID: string\nuserName: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessString\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current supported value is Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enoPasswordRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates a password is not required for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003ePasswords used for this user. You can create up to two passwords for each user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswords.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserName\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username of the user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nauthentication: \n passwordCount: integer\n type_: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nexpandedAccessString: string\nlastRequestedAccessString: string\nminimumEngineVersion: string\nstatus: string\nuserGroupIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDenotes whether the user requires a password to authenticate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication.passwordCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authentication.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexpandedAccessString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastRequestedAccessString\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version required, which is Redis 6.0\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the user status. Can be \u0026ldquo;active\u0026rdquo;, \u0026ldquo;modifying\u0026rdquo; or \u0026ldquo;deleting\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eReturns a list of the user group IDs the user belongs to.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:185,href:"https://aws-controllers-k8s.github.io/community/reference/iam/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003eiam.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/iam-controller/apis/v1alpha1#User"\u003eiam-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eContains information about an IAM user entity.\u003c/p\u003e\n\u003cp\u003eThis data type is used as a response element in the following operations:\u003c/p\u003e\n\u003cul\u003e\n\u003cli\u003e\n\u003cp\u003eCreateUser\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eGetUser\u003c/p\u003e\n\u003c/li\u003e\n\u003cli\u003e\n\u003cp\u003eListUsers\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ul\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003einlinePolicies: {}\nname: string\npath: string\npermissionsBoundary: string\npermissionsBoundaryRef: \n from: \n name: string\npolicies:\n- string\npolicyRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einlinePolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the user to create.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIAM user, group, role, and policy names must be unique within the account.\u003cbr/\u003eNames are not distinguished by case. For example, you cannot create resources\u003cbr/\u003enamed both \u0026ldquo;MyResource\u0026rdquo; and \u0026ldquo;myresource\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe path for the user name. For more information about paths, see IAM identifiers\u003cbr/\u003e(https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter is optional. If it is not included, it defaults to a slash\u003cbr/\u003e(/).\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis parameter allows (through its regex pattern (http://wikipedia.org/wiki/regex))\u003cbr/\u003ea string of characters consisting of either a forward slash (/) by itself\u003cbr/\u003eor a string that must begin and end with forward slashes. In addition, it\u003cbr/\u003ecan contain any ASCII character from the ! (\\u0021) through the DEL character\u003cbr/\u003e(\\u007F), including most punctuation characters, digits, and upper and lowercased\u003cbr/\u003eletters.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundary\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the managed policy that is used to set the permissions boundary\u003cbr/\u003efor the user.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA permissions boundary policy defines the maximum permissions that identity-based\u003cbr/\u003epolicies can grant to an entity, but does not grant permissions. Permissions\u003cbr/\u003eboundaries do not define the maximum permissions that a resource-based policy\u003cbr/\u003ecan grant to an entity. To learn more, see Permissions boundaries for IAM\u003cbr/\u003eentities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about policy types, see Policy types (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epermissionsBoundaryRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicies.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **policyRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003epolicyRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags that you want to attach to the new user. Each tag consists\u003cbr/\u003eof a key name and an associated value. For more information about tagging,\u003cbr/\u003esee Tagging IAM resources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\u003cbr/\u003ein the IAM User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eIf any one of the tags is invalid or if you exceed the allowed maximum number\u003cbr/\u003eof tags, then the entire request fails and the resource is not created. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA structure that represents user-provided metadata that can be associated\nwith an IAM resource. For more information about tagging, see Tagging IAM\nresources (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html)\nin the IAM User Guide. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreateDate: string\npasswordLastUsed: string\nuserID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreateDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the user was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epasswordLastUsed\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),\u003cbr/\u003ewhen the user\u0026rsquo;s password was last used to sign in to an Amazon Web Services\u003cbr/\u003ewebsite. For a list of Amazon Web Services websites that capture a user\u0026rsquo;s\u003cbr/\u003elast sign-in time, see the Credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html)\u003cbr/\u003etopic in the IAM User Guide. If a password is used more than once in a five-minute\u003cbr/\u003espan, only the first use is returned in this field. If the field is null\u003cbr/\u003e(no value), then it indicates that they never signed in with a password.\u003cbr/\u003eThis can be because:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * The user never had a password.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * A password exists but has not been used since IAM started tracking this\u003cbr/\u003e information on October 20, 2014.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eA null value does not mean that the user never had a password. Also, if the\u003cbr/\u003euser does not currently have a password but had one in the past, then this\u003cbr/\u003efield contains the date and time the most recent password was used.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThis value is returned only in the GetUser and ListUsers operations.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe stable and unique string identifying the user. For more information about\u003cbr/\u003eIDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)\u003cbr/\u003ein the IAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:186,href:"https://aws-controllers-k8s.github.io/community/reference/memorydb/v1alpha1/user/",title:"User",description:null,content:'\u003cp\u003e\u003ccode\u003ememorydb.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/memorydb-controller/apis/v1alpha1#User"\u003ememorydb-controller/apis/v1alpha1#User\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusers\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euser\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou create users and assign them specific permissions by using an access string. You assign the users to Access Control Lists aligned with a specific role (administrators, human resources) that are then deployed to one or more MemoryDB clusters.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccessString: string\nauthenticationMode: \n passwords:\n - key: string\n name: string\n namespace: string\n type_: string\nname: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccessString\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAccess permissions string used for this user.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDenotes the user\u0026rsquo;s authentication properties, such as whether it requires a password to authenticate.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSecretKeyReference combines a k8s corev1.SecretReference with a specific key within the referred-to Secret\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[].name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003ename is unique within a namespace to reference a secret resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthenticationMode.passwords.[].namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003enamespace defines the space within which the secret name must be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authenticationMode.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the user. This value must be unique as it also serves as the user identifier.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources (https://docs.aws.amazon.com/MemoryDB/latest/devguide/tagging-resources.html)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\naclNames:\n- string\nauthentication: \n passwordCount: integer\n type_: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nevents:\n- date: string\n message: string\n sourceName: string\n sourceType: string\nminimumEngineVersion: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclNames\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe names of the Access Control Lists to which the user belongs\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaclNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eauthentication.passwordCount\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**authentication.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of events. Each element in the list contains detailed information about one event.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eRepresents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eevents.[].sourceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version supported for the user\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eIndicates the user status. Can be \u0026ldquo;active\u0026rdquo;, \u0026ldquo;modifying\u0026rdquo; or \u0026ldquo;deleting\u0026rdquo;.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:187,href:"https://aws-controllers-k8s.github.io/community/reference/elasticache/v1alpha1/usergroup/",title:"UserGroup",description:null,content:'\u003cp\u003e\u003ccode\u003eelasticache.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/elasticache-controller/apis/v1alpha1#UserGroup"\u003eelasticache-controller/apis/v1alpha1#UserGroup\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserGroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserGroupList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusergroups\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eusergroup\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eengine: string\ntags:\n- key: string\n value: string\nuserGroupID: string\nuserIDs:\n- string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eengine\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current supported value is Redis.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eA list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your ElastiCache resources, with the exception of global replication group. When you add or remove tags on replication groups, those actions will be replicated to all nodes in the replication group. A tag with a null Value is permitted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserGroupID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe list of user IDs that belong to the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003euserIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nminimumEngineVersion: string\npendingChanges: \n userIDsToAdd:\n - string\n userIDsToRemove:\n - string\nreplicationGroups:\n- string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member that is used to contain resource sync state, account ownership, constructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR\u0026rsquo;s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that contains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe the various terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eminimumEngineVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe minimum engine version required, which is Redis 6.0\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA list of updates being applied to the user group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToAdd\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToAdd.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ependingChanges.userIDsToRemove.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ereplicationGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:188,href:"https://aws-controllers-k8s.github.io/community/reference/sagemaker/v1alpha1/userprofile/",title:"UserProfile",description:null,content:'\u003cp\u003e\u003ccode\u003esagemaker.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/sagemaker-controller/apis/v1alpha1#UserProfile"\u003esagemaker-controller/apis/v1alpha1#UserProfile\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserProfile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eUserProfileList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euserprofiles\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003euserprofile\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003edomainID: string\nsingleSignOnUserIdentifier: string\nsingleSignOnUserValue: string\ntags:\n- key: string\n value: string\nuserProfileName: string\nuserSettings: \n codeEditorAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n customFileSystemConfigs:\n efsFileSystemConfig: \n fileSystemID: string\n fileSystemPath: string\n customPosixUserConfig: \n gid: integer\n uid: integer\n defaultLandingURI: string\n executionRole: string\n jupyterLabAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n jupyterServerAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n kernelGatewayAppSettings: \n customImages:\n - appImageConfigName: string\n imageName: string\n imageVersionNumber: integer\n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n lifecycleConfigARNs:\n - string\n rStudioServerProAppSettings: \n accessStatus: string\n userGroup: string\n securityGroups:\n - string\n sharingSettings: \n notebookOutputOption: string\n s3KMSKeyID: string\n s3OutputPath: string\n spaceStorageSettings: \n defaultEBSStorageSettings: \n defaultEBSVolumeSizeInGb: integer\n maximumEBSVolumeSizeInGb: integer\n studioWebPortal: string\n tensorBoardAppSettings: \n defaultResourceSpec: \n instanceType: string\n lifecycleConfigARN: string\n sageMakerImageARN: string\n sageMakerImageVersionARN: string\n sageMakerImageVersionAlias: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edomainID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the associated Domain.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esingleSignOnUserIdentifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA specifier for the type of value specified in SingleSignOnUserValue. Currently,\u003cbr/\u003ethe only supported value is \u0026ldquo;UserName\u0026rdquo;. If the Domain\u0026rsquo;s AuthMode is IAM Identity\u003cbr/\u003eCenter, this field is required. If the Domain\u0026rsquo;s AuthMode is not IAM Identity\u003cbr/\u003eCenter, this field cannot be specified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esingleSignOnUserValue\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe username of the associated Amazon Web Services Single Sign-On User for\u003cbr/\u003ethis UserProfile. If the Domain\u0026rsquo;s AuthMode is IAM Identity Center, this field\u003cbr/\u003eis required, and must match a valid username of a user in your directory.\u003cbr/\u003eIf the Domain\u0026rsquo;s AuthMode is not IAM Identity Center, this field cannot be\u003cbr/\u003especified.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eEach tag consists of a key and an optional value. Tag keys must be unique\u003cbr/\u003eper resource.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTags that you specify for the User Profile are also added to all Apps that\u003cbr/\u003ethe User Profile launches.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA tag object that consists of a key and an optional value, used to manage\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003emetadata for SageMaker Amazon Web Services resources.\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eYou can add tags to notebook instances, training jobs, hyperparameter tuning\njobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations,\nand endpoints. For more information on adding tags to SageMaker resources,\nsee AddTags (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AddTags.html).\u003c/p\u003e\n\u003cp\u003eFor more information on adding metadata to your Amazon Web Services resources\nwith tagging, see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).\nFor advice on best practices for managing Amazon Web Services resources with\ntagging, see Tagging Best Practices: Implement an Effective Amazon Web Services\nResource Tagging Strategy (https://d1.awsstatic.com/whitepapers/aws-tagging-best-practices.pdf). || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserProfileName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA name for the UserProfile. This value is not case sensitive. |\n| \u003cstrong\u003euserSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings. |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe Code Editor application settings.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eFor more information about Code Editor, see Get started with Code Editor\u003cbr/\u003ein Amazon SageMaker (https://docs.aws.amazon.com/sagemaker/latest/dg/code-editor.html). |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.codeEditorAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.customFileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom file system to a user profile or space\nfor an Amazon SageMaker Domain. Permitted users can access this file system\nin Amazon SageMaker Studio. || \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for assigning a custom Amazon EFS file system to a user profile\u003cbr/\u003eor space for an Amazon SageMaker Domain. |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customFileSystemConfigs.[].efsFileSystemConfig.fileSystemPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customPosixUserConfig\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the POSIX identity that is used for file system operations. |\n| \u003cstrong\u003euserSettings.customPosixUserConfig.gid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.customPosixUserConfig.uid\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.defaultLandingURI\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.executionRole\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe settings for the JupyterLab application. |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\nimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). || \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].appImageConfigName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterLabAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.jupyterServerAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe JupyterServer app settings. |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.jupyterServerAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.kernelGatewayAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe KernelGateway app settings. |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA custom SageMaker image. For more information, see Bring your own SageMaker\nimage (https://docs.aws.amazon.com/sagemaker/latest/dg/studio-byoi.html). || \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].appImageConfigName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].imageName\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.customImages.[].imageVersionNumber\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.lifecycleConfigARNs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.kernelGatewayAppSettings.lifecycleConfigARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.rStudioServerProAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of settings that configure user interaction with the RStudioServerPro\u003cbr/\u003eapp. |\n| \u003cstrong\u003euserSettings.rStudioServerProAppSettings.accessStatus\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.rStudioServerProAppSettings.userGroup\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.securityGroups\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.securityGroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003euserSettings.sharingSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies options for sharing Amazon SageMaker Studio notebooks. These settings\u003cbr/\u003eare specified as part of DefaultUserSettings when the CreateDomain API is\u003cbr/\u003ecalled, and as part of UserSettings when the CreateUserProfile API is called.\u003cbr/\u003eWhen SharingSettings is not specified, notebook sharing isn\u0026rsquo;t allowed. |\n| \u003cstrong\u003euserSettings.sharingSettings.notebookOutputOption\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.sharingSettings.s3KMSKeyID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.sharingSettings.s3OutputPath\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.spaceStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe default storage settings for a private space. |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA collection of default EBS storage settings that applies to private spaces\u003cbr/\u003ecreated within a domain or user profile. |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings.defaultEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.spaceStorageSettings.defaultEBSStorageSettings.maximumEBSVolumeSizeInGb\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.studioWebPortal\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe TensorBoard app settings. |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSpecifies the ARN\u0026rsquo;s of a SageMaker image and SageMaker image version, and\u003cbr/\u003ethe instance type that the version runs on. |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.instanceType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.lifecycleConfigARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003euserSettings.tensorBoardAppSettings.defaultResourceSpec.sageMakerImageVersionAlias\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:189,href:"https://aws-controllers-k8s.github.io/community/reference/lambda/v1alpha1/version/",title:"Version",description:null,content:'\u003cp\u003e\u003ccode\u003elambda.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/lambda-controller/apis/v1alpha1#Version"\u003elambda-controller/apis/v1alpha1#Version\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVersion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVersionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eversions\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eversion\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ecodeSHA256: string\ndescription: string\nfunctionEventInvokeConfig: \n destinationConfig: \n onFailure: \n destination: string\n onSuccess: \n destination: string\n functionName: string\n maximumEventAgeInSeconds: integer\n maximumRetryAttempts: integer\n qualifier: string\nfunctionName: string\nfunctionRef: \n from: \n name: string\nprovisionedConcurrencyConfig: \n functionName: string\n provisionedConcurrentExecutions: integer\n qualifier: string\nrevisionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecodeSHA256\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOnly publish a version if the hash value matches the value that\u0026rsquo;s specified.\u003cbr/\u003eUse this option to avoid publishing a version if the function code has changed\u003cbr/\u003esince you last updated it. You can get the hash for the version that you\u003cbr/\u003euploaded from the output of UpdateFunctionCode.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edescription\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA description for the version to override the description in the function\u003cbr/\u003econfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA configuration object that specifies the destination of an event after Lambda\u003cbr/\u003eprocesses it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that failed processing.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onFailure.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eA destination for events that were processed successfully.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.destinationConfig.onSuccess.destination\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumEventAgeInSeconds\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.maximumRetryAttempts\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionEventInvokeConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the Lambda function.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eName formats\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function name - MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e * Partial ARN - 123456789012:function:MyFunction.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eThe length constraint applies only to the full ARN. If you specify only the\u003cbr/\u003efunction name, it is limited to 64 characters in length.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.functionName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.provisionedConcurrentExecutions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprovisionedConcurrencyConfig.qualifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erevisionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOnly update the function if the revision ID matches the ID that\u0026rsquo;s specified.\u003cbr/\u003eUse this option to avoid publishing a version if the function configuration\u003cbr/\u003ehas changed since you last updated it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\narchitectures:\n- string\ncodeSize: integer\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndeadLetterConfig: \n targetARN: string\nenvironment: \n error: \n errorCode: string\n message: string\n variables: {}\nephemeralStorage: \n size: integer\nfileSystemConfigs:\n- arn: string\n localMountPath: string\nfunctionARN: string\nhandler: string\nimageConfigResponse: \n error: \n errorCode: string\n message: string\n imageConfig: \n command:\n - string\n entryPoint:\n - string\n workingDirectory: string\nkmsKeyARN: string\nlastModified: string\nlastUpdateStatus: string\nlastUpdateStatusReason: string\nlastUpdateStatusReasonCode: string\nlayers:\n- arn: string\n codeSize: integer\n signingJobARN: string\n signingProfileVersionARN: string\nmasterARN: string\nmemorySize: integer\npackageType: string\nqualifier: string\nrole: string\nruntime: string\nsigningJobARN: string\nsigningProfileVersionARN: string\nsnapStart: \n applyOn: string\n optimizationStatus: string\nstate: string\nstateReason: string\nstateReasonCode: string\ntimeout: integer\ntracingConfig: \n mode: string\nversion: string\nvpcConfig: \n securityGroupIDs:\n - string\n subnetIDs:\n - string\n vpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe instruction set architecture that the function supports. Architecture\u003cbr/\u003eis a string array with one of the valid values. The default architecture\u003cbr/\u003evalue is x86_64.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003earchitectures.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s dead letter queue.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edeadLetterConfig.targetARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).\u003cbr/\u003eOmitted from CloudTrail logs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError messages for environment variables that couldn\u0026rsquo;t be applied.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenvironment.variables\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe size of the function’s /tmp directory in MB. The default value is 512,\u003cbr/\u003ebut it can be any whole number between 512 and 10,240 MB.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eephemeralStorage.size\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eConnection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDetails about the connection between a Lambda function and an Amazon EFS\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003efile system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efileSystemConfigs.[].localMountPath\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003efunctionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s Amazon Resource Name (ARN).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ehandler\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function that Lambda calls to begin running your function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s image configuration values.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eError response to GetFunctionConfiguration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.errorCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.error.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eConfiguration values that override the container image Dockerfile settings.\u003cbr/\u003eFor more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.command.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eimageConfigResponse.imageConfig.entryPoint.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ekmsKeyARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe KMS key that\u0026rsquo;s used to encrypt the function\u0026rsquo;s environment variables.\u003cbr/\u003eThis key is returned only if you\u0026rsquo;ve configured a customer managed key.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastModified\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the function was last updated, in ISO-8601 format\u003cbr/\u003e(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe status of the last update that was performed on the function. This is\u003cbr/\u003efirst set to Successful after function creation completes.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastUpdateStatusReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the last update that was performed on the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAn Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].codeSize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].signingJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elayers.[].signingProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emasterARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eFor Lambda@Edge functions, the ARN of the main function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ememorySize\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of memory available to the function at runtime.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epackageType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of deployment package. Set to Image for container image and set\u003cbr/\u003eZip for .zip file archive.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003equalifier\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erole\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s execution role.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eruntime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe runtime environment for the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningJobARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing job.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esigningProfileVersionARN\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ARN of the signing profile version.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eSet ApplyOn to PublishedVersions to create a snapshot of the initialized\u003cbr/\u003eexecution environment when you publish a function version. For more information,\u003cbr/\u003esee Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.applyOn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esnapStart.optimizationStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the function. When the state is Inactive, you can reactivate\u003cbr/\u003ethe function by invoking it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the function\u0026rsquo;s current state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estateReasonCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason code for the function\u0026rsquo;s current state. When the code is Creating,\u003cbr/\u003eyou can\u0026rsquo;t invoke or modify the function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etimeout\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe amount of time in seconds that Lambda allows a function to run before\u003cbr/\u003estopping it.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s X-Ray tracing configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etracingConfig.mode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eversion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe version of the Lambda function.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe function\u0026rsquo;s networking configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.securityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcConfig.subnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:190,href:"https://aws-controllers-k8s.github.io/community/reference/emrcontainers/v1alpha1/virtualcluster/",title:"VirtualCluster",description:null,content:'\u003cp\u003e\u003ccode\u003eemrcontainers.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/emrcontainers-controller/apis/v1alpha1#VirtualCluster"\u003eemrcontainers-controller/apis/v1alpha1#VirtualCluster\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVirtualCluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVirtualClusterList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evirtualclusters\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evirtualcluster\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eThis entity describes a virtual cluster. A virtual cluster is a Kubernetes\nnamespace that Amazon EMR is registered with. Amazon EMR uses virtual clusters\nto run jobs and host endpoints. Multiple virtual clusters can be backed by\nthe same physical cluster. However, each virtual cluster maps to one namespace\non an EKS cluster. Virtual clusters do not create any active resources that\ncontribute to your bill or that require lifecycle management outside the\nservice.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003econtainerProvider: \n id: string\n info: \n eksInfo: \n namespace: string\n type_: string\nname: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe container provider of the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.id\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about the container used for a job run or a managed endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info.eksInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe information about the EKS cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econtainerProvider.info.eksInfo.namespace\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**containerProvider.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe specified name of the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe tags assigned to the virtual cluster.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nid: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eid\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThis output contains the virtual cluster ID.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:191,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpc/",title:"VPC",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPC"\u003eec2-controller/apis/v1alpha1#VPC\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPC\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcs\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpc\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eamazonProvidedIPv6CIDRBlock: boolean\ncidrBlocks:\n- string\nenableDNSHostnames: boolean\nenableDNSSupport: boolean\ninstanceTenancy: string\nipv4IPAMPoolID: string\nipv4NetmaskLength: integer\nipv6CIDRBlock: string\nipv6CIDRBlockNetworkBorderGroup: string\nipv6IPAMPoolID: string\nipv6NetmaskLength: integer\nipv6Pool: string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eamazonProvidedIPv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eRequests an Amazon-provided IPv6 CIDR block with a /56 prefix length for\u003cbr/\u003ethe VPC. You cannot specify the range of IP addresses, or the size of the\u003cbr/\u003eCIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlocks\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlocks.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eenableDNSSupport\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eThe attribute value. The valid values are true or false.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003einstanceTenancy\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe tenancy options for instances launched into the VPC. For default, instances\u003cbr/\u003eare launched with shared tenancy by default. You can launch instances with\u003cbr/\u003eany tenancy into a shared tenancy VPC. For dedicated, instances are launched\u003cbr/\u003eas dedicated tenancy instances by default. You can only launch instances\u003cbr/\u003ewith a tenancy of dedicated or host into a dedicated tenancy VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eImportant: The host value cannot be used with this parameter. Use the default\u003cbr/\u003eor dedicated values only.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: default\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv4IPAMPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv4 IPAM pool you want to use for allocating this VPC\u0026rsquo;s CIDR.\u003cbr/\u003eFor more information, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv4NetmaskLength\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe netmask length of the IPv4 CIDR you want to allocate to this VPC from\u003cbr/\u003ean Amazon VPC IP Address Manager (IPAM) pool. For more information about\u003cbr/\u003eIPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool\u003cbr/\u003ein the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo let Amazon choose the IPv6 CIDR block for you, omit this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockNetworkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the location from which we advertise the IPV6 CIDR block. Use\u003cbr/\u003ethis parameter to limit the address to this location.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eYou must set AmazonProvidedIpv6CidrBlock to true to use this parameter.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6IPAMPoolID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6\u003cbr/\u003eCIDR. IPAM is a VPC feature that you can use to automate your IP address\u003cbr/\u003emanagement workflows including assigning, tracking, troubleshooting, and\u003cbr/\u003eauditing IP addresses across Amazon Web Services Regions and accounts throughout\u003cbr/\u003eyour Amazon Web Services Organization. For more information, see What is\u003cbr/\u003eIPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6NetmaskLength\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003einteger\u003c/strong\u003e\u003cbr/\u003eThe netmask length of the IPv6 CIDR you want to allocate to this VPC from\u003cbr/\u003ean Amazon VPC IP Address Manager (IPAM) pool. For more information about\u003cbr/\u003eIPAM, see What is IPAM? (https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html)\u003cbr/\u003ein the Amazon VPC IPAM User Guide.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\ncidrBlockAssociationSet:\n- associationID: string\n cidrBlock: string\n cidrBlockState: \n state: string\n statusMessage: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ndhcpOptionsID: string\nipv6CIDRBlockAssociationSet:\n- associationID: string\n ipv6CIDRBlock: string\n ipv6CIDRBlockState: \n state: string\n statusMessage: string\n ipv6Pool: string\n networkBorderGroup: string\nisDefault: boolean\nownerID: string\nstate: string\nvpcID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv4 CIDR blocks associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block associated with a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecidrBlockAssociationSet.[].cidrBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003edhcpOptionsID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the set of DHCP options you\u0026rsquo;ve associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eInformation about the IPv6 CIDR blocks associated with the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block associated with a VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the state of a CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].ipv6Pool\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipv6CIDRBlockAssociationSet.[].networkBorderGroup\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eisDefault\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the VPC is the default VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the Amazon Web Services account that owns the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe current state of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:192,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcendpoint/",title:"VPCEndpoint",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCEndpoint"\u003eec2-controller/apis/v1alpha1#VPCEndpoint\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpoints\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpoint\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC endpoint.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ednsOptions: \n dnsRecordIPType: string\nipAddressType: string\npolicyDocument: string\nprivateDNSEnabled: boolean\nrouteTableIDs:\n- string\nrouteTableRefs:\n from: \n name: string\nsecurityGroupIDs:\n- string\nsecurityGroupRefs:\n from: \n name: string\nserviceName: string\nsubnetIDs:\n- string\nsubnetRefs:\n from: \n name: string\ntags:\n- key: string\n value: string\nvpcEndpointType: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe DNS options for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsOptions.dnsRecordIPType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eipAddressType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe IP address type for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epolicyDocument\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e(Interface and gateway endpoints) A policy to attach to the endpoint that\u003cbr/\u003econtrols access to the service. The policy must be in valid JSON format.\u003cbr/\u003eIf this parameter is not specified, we attach a default policy that allows\u003cbr/\u003efull access to the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSEnabled\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) Indicates whether to associate a private hosted zone\u003cbr/\u003ewith the specified VPC. The private hosted zone contains a record set for\u003cbr/\u003ethe default public DNS name for the service for the Region (for example,\u003cbr/\u003ekinesis.us-east-1.amazonaws.com), which resolves to the private IP addresses\u003cbr/\u003eof the endpoint network interfaces in the VPC. This enables you to make requests\u003cbr/\u003eto the default public DNS name for the service instead of the public DNS\u003cbr/\u003enames that are automatically generated by the VPC endpoint service.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eTo use a private hosted zone, you must set the following VPC attributes to\u003cbr/\u003etrue: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to\u003cbr/\u003eset the VPC attributes.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: true\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Gateway endpoint) One or more route table IDs.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erouteTableRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eEx:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eAPIIDRef:\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **routeTableRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003erouteTableRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) The ID of one or more security groups to associate with\u003cbr/\u003ethe endpoint network interface. |\n| \u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esecurityGroupRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esecurityGroupRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **securityGroupRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esecurityGroupRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003eserviceName\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe service name. To get a list of available services, use the DescribeVpcEndpointServices\u003cbr/\u003erequest, or get the name from the service provider. |\n| \u003cstrong\u003esubnetIDs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets\u003cbr/\u003ein which to create an endpoint network interface. For a Gateway Load Balancer\u003cbr/\u003eendpoint, you can specify one subnet only. |\n| \u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e || \u003cstrong\u003esubnetRefs\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003esubnetRefs.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\ntype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\nEx:\nAPIIDRef:\u003c/p\u003e\n\u003cpre\u003e\u003ccode\u003efrom:\n name: my-api || **subnetRefs.[].from**\u0026lt;br/\u0026gt;Optional | **object**\u0026lt;br/\u0026gt;AWSResourceReference provides all the values necessary to reference another\u0026lt;br/\u0026gt;k8s resource for finding the identifier(Id/ARN/Name) |\n\u003c/code\u003e\u003c/pre\u003e\n\u003cp\u003e| \u003cstrong\u003esubnetRefs.[].from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string. |\n| \u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag. || \u003cstrong\u003etags.[].key\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\n| \u003cstrong\u003evpcEndpointType\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe type of endpoint.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Gateway |\n| \u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC in which the endpoint will be used. |\n| \u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api |\n| \u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name) |\n| \u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional | \u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e |\u003c/p\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreationTimestamp: string\ndnsEntries:\n- dnsName: string\n hostedZoneID: string\ngroups:\n- groupID: string\n groupName: string\nlastError: \n code: string\n message: string\nnetworkInterfaceIDs:\n- string\nownerID: string\nrequesterManaged: boolean\nstate: string\nvpcEndpointID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreationTimestamp\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe date and time that the endpoint was created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) The DNS entries for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a DNS entry.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ednsEntries.[].hostedZoneID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) Information about the security groups that are associated\u003cbr/\u003ewith the network interface.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a security group.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egroups.[].groupName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe last error that occurred for endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003elastError.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e(Interface endpoint) One or more network interfaces for the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkInterfaceIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterManaged\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the endpoint is being managed by its service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe state of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcEndpointID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:193,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/",title:"VPCEndpointServiceConfiguration",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCEndpointServiceConfiguration"\u003eec2-controller/apis/v1alpha1#VPCEndpointServiceConfiguration\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointServiceConfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCEndpointServiceConfigurationList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpointserviceconfigurations\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcendpointserviceconfiguration\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceptanceRequired: boolean\nallowedPrincipals:\n- string\ngatewayLoadBalancerARNs:\n- string\nnetworkLoadBalancerARNs:\n- string\nprivateDNSName: string\nsupportedIPAddressTypes:\n- string\ntags:\n- key: string\n value: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceptanceRequired\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether requests from service consumers to create an endpoint to\u003cbr/\u003eyour service must be accepted manually.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPrincipals\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Amazon Resource Names (ARN) of one or more principals. Permissions are\u003cbr/\u003egranted to the principals in this list. To grant permissions to all principals,\u003cbr/\u003especify an asterisk (*).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eallowedPrincipals.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003egatewayLoadBalancerARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003enetworkLoadBalancerARNs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedIPAddressTypes\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe supported IP address types. The possible values are ipv4 and ipv6.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esupportedIPAddressTypes.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\navailabilityZones:\n- string\nbaseEndpointDNSNames:\n- string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nmanagesVPCEndpoints: boolean\npayerResponsibility: string\nprivateDNSNameConfiguration: \n name: string\n state: string\n type_: string\n value: string\nserviceID: string\nserviceName: string\nserviceState: string\nserviceType:\n- serviceType: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe Availability Zones in which the service is available.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eavailabilityZones.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ebaseEndpointDNSNames.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003emanagesVPCEndpoints\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003eIndicates whether the service manages its VPC endpoints. Management of the\u003cbr/\u003eservice VPC endpoints using the VPC endpoint API is restricted.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epayerResponsibility\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe payer responsibility.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the endpoint service private DNS name configuration.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.state\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e**privateDNSNameConfiguration.type_**\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eprivateDNSNameConfiguration.value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceName\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe name of the service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceState\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe service state.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceType\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe type of service.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eserviceType.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes the type of service for a VPC endpoint.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:194,href:"https://aws-controllers-k8s.github.io/community/reference/apigatewayv2/v1alpha1/vpclink/",title:"VPCLink",description:null,content:'\u003cp\u003e\u003ccode\u003eapigatewayv2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/apigatewayv2-controller/apis/v1alpha1#VPCLink"\u003eapigatewayv2-controller/apis/v1alpha1#VPCLink\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCLink\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCLinkList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpclinks\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpclink\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eRepresents a VPC link.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ename: string\nsecurityGroupIDs:\n- string\nsubnetIDs:\n- string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ename\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esecurityGroupIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003esubnetIDs.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\ncreatedDate: string\nvpcLinkID: string\nvpcLinkStatus: string\nvpcLinkStatusMessage: string\nvpcLinkVersion: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ecreatedDate\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkStatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkStatusMessage\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcLinkVersion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:195,href:"https://aws-controllers-k8s.github.io/community/reference/ec2/v1alpha1/vpcpeeringconnection/",title:"VPCPeeringConnection",description:null,content:'\u003cp\u003e\u003ccode\u003eec2.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/ec2-controller/apis/v1alpha1#VPCPeeringConnection"\u003eec2-controller/apis/v1alpha1#VPCPeeringConnection\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCPeeringConnection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eVPCPeeringConnectionList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcpeeringconnections\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003evpcpeeringconnection\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003cp\u003eDescribes a VPC peering connection.\u003c/p\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eacceptRequest: boolean\naccepterPeeringConnectionOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\npeerOwnerID: string\npeerRegion: string\npeerVPCID: string\npeerVPCRef: \n from: \n name: string\nrequesterPeeringConnectionOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\ntags:\n- key: string\n value: string\nvpcID: string\nvpcRef: \n from: \n name: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eacceptRequest\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe VPC peering connection options for the accepter VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterPeeringConnectionOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerOwnerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Amazon Web Services account ID of the owner of the accepter VPC.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: Your Amazon Web Services account ID\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerRegion\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe Region code for the accepter VPC, if the accepter VPC is located in a\u003cbr/\u003eRegion other than the Region in which you make the request.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDefault: The Region in which you make the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC with which you are creating the VPC peering connection.\u003cbr/\u003eYou must specify this parameter in the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003epeerVPCRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe VPC peering connection options for the requester VPC.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterPeeringConnectionOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eThe tags. The value parameter is required, but if you don\u0026rsquo;t want the tag\u003cbr/\u003eto have a value, specify the parameter with no value, and we set the value\u003cbr/\u003eto an empty string.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes a tag.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags.[].value\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the requester VPC. You must specify this parameter in the request.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference\u003cbr/\u003etype to provide more user friendly syntax for references using \u0026lsquo;from\u0026rsquo; field\u003cbr/\u003eEx:\u003cbr/\u003eAPIIDRef:\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003e from:\u003cbr/\u003e name: my-api\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAWSResourceReference provides all the values necessary to reference another\u003cbr/\u003ek8s resource for finding the identifier(Id/ARN/Name)\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcRef.from.name\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eaccepterVPCInfo: \n cidrBlock: string\n cidrBlockSet:\n - cidrBlock: string\n ipv6CIDRBlockSet:\n - ipv6CIDRBlock: string\n ownerID: string\n peeringOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\n region: string\n vpcID: string\nackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nexpirationTime: string\nrequesterVPCInfo: \n cidrBlock: string\n cidrBlockSet:\n - cidrBlock: string\n ipv6CIDRBlockSet:\n - ipv6CIDRBlock: string\n ownerID: string\n peeringOptions: \n allowDNSResolutionFromRemoteVPC: boolean\n allowEgressFromLocalClassicLinkToRemoteVPC: boolean\n allowEgressFromLocalVPCToRemoteClassicLink: boolean\n region: string\n vpcID: string\nstatus: \n code: string\n message: string\nvpcPeeringConnectionID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the accepter VPC. CIDR block information is only returned\u003cbr/\u003ewhen describing an active VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.cidrBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ipv6CIDRBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ipv6CIDRBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.ownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\u003cbr/\u003efrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\u003cbr/\u003eto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDescribes the VPC peering connection options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eaccepterVPCInfo.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eexpirationTime\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe time that an unaccepted VPC peering connection will expire.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eInformation about the requester VPC. CIDR block information is only returned\u003cbr/\u003ewhen describing an active VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlock\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.cidrBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv4 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ipv6CIDRBlockSet\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ipv6CIDRBlockSet.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eDescribes an IPv6 CIDR block.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.ownerID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eWe are retiring EC2-Classic on August 15, 2022. We recommend that you migrate\u003cbr/\u003efrom EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic\u003cbr/\u003eto a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)\u003cbr/\u003ein the Amazon Elastic Compute Cloud User Guide.\u003cbr/\u003e\u003cbr/\u003e\u003cbr/\u003eDescribes the VPC peering connection options.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eboolean\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.region\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003erequesterVPCInfo.vpcID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.code\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003evpcPeeringConnectionID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe ID of the VPC peering connection.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}).add({id:196,href:"https://aws-controllers-k8s.github.io/community/reference/prometheusservice/v1alpha1/workspace/",title:"Workspace",description:null,content:'\u003cp\u003e\u003ccode\u003eprometheusservice.services.k8s.aws/v1alpha1\u003c/code\u003e\u003c/p\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eType\u003c/th\u003e\n\u003cth\u003eLink\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eGoDoc\u003c/td\u003e\n\u003ctd\u003e\u003ca href="https://pkg.go.dev/github.com/aws-controllers-k8s/prometheusservice-controller/apis/v1alpha1#Workspace"\u003eprometheusservice-controller/apis/v1alpha1#Workspace\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="metadata"\u003eMetadata\u003c/h2\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eProperty\u003c/th\u003e\n\u003cth\u003eValue\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003eScope\u003c/td\u003e\n\u003ctd\u003eNamespaced\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eWorkspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eListKind\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eWorkspaceList\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003ePlural\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eworkspaces\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eSingular\u003c/td\u003e\n\u003ctd\u003e\u003ccode\u003eworkspace\u003c/code\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="spec"\u003eSpec\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003ealias: string\ntags: {}\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003ealias\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eAn optional user-assigned alias for this workspace. This alias is for user\u003cbr/\u003ereference and does not need to be unique.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003etags\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eOptional, user-provided tags for this workspace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n\u003ch2 id="status"\u003eStatus\u003c/h2\u003e\n\u003cpre\u003e\u003ccode class="language-yaml"\u003eackResourceMetadata: \n arn: string\n ownerAccountID: string\n region: string\nconditions:\n- lastTransitionTime: string\n message: string\n reason: string\n status: string\n type: string\nstatus: \n statusCode: string\nworkspaceID: string\n\u003c/code\u003e\u003c/pre\u003e\n\u003ctable\u003e\n\u003cthead\u003e\n\u003ctr\u003e\n\u003cth\u003eField\u003c/th\u003e\n\u003cth\u003eDescription\u003c/th\u003e\n\u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eAll CRs managed by ACK have a common \u003ccode\u003eStatus.ACKResourceMetadata\u003c/code\u003e member\u003cbr/\u003ethat is used to contain resource sync state, account ownership,\u003cbr/\u003econstructed ARN for the resource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.arn\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eARN is the Amazon Resource Name for the resource. This is a\u003cbr/\u003eglobally-unique identifier and is set only by the ACK service controller\u003cbr/\u003eonce the controller has orchestrated the creation of the resource OR\u003cbr/\u003ewhen it has verified that an \u0026ldquo;adopted\u0026rdquo; resource (a resource where the\u003cbr/\u003eARN annotation was set by the Kubernetes user on the CR) exists and\u003cbr/\u003ematches the supplied CR\u0026rsquo;s Spec field values.\u003cbr/\u003eTODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse\u003cbr/\u003ehttps://github.com/aws/aws-controllers-k8s/issues/270\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.ownerAccountID\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eOwnerAccountID is the AWS Account ID of the account that owns the\u003cbr/\u003ebackend AWS service API resource.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eackResourceMetadata.region\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eRegion is the AWS region in which the resource exists or will exist.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003earray\u003c/strong\u003e\u003cbr/\u003eAll CRS managed by ACK have a common \u003ccode\u003eStatus.Conditions\u003c/code\u003e member that\u003cbr/\u003econtains a collection of \u003ccode\u003eackv1alpha1.Condition\u003c/code\u003e objects that describe\u003cbr/\u003ethe various terminal states of the CR and its backend AWS service API\u003cbr/\u003eresource\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[]\u003c/strong\u003e\u003cbr/\u003eRequired\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eCondition is the common struct used by all CRDs managed by ACK service\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003econtrollers to indicate terminal states of the CR and its backend AWS\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003eservice API resource\u003c/td\u003e\n\u003ctd\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].message\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eA human readable message indicating details about the transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].reason\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe reason for the condition\u0026rsquo;s last transition.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].status\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eStatus of the condition, one of True, False, Unknown.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003econditions.[].type\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eType is the type of the Condition\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003eobject\u003c/strong\u003e\u003cbr/\u003eThe status of the workspace that was just created (usually CREATING).\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003estatus.statusCode\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eState of a workspace.\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd\u003e\u003cstrong\u003eworkspaceID\u003c/strong\u003e\u003cbr/\u003eOptional\u003c/td\u003e\n\u003ctd\u003e\u003cstrong\u003estring\u003c/strong\u003e\u003cbr/\u003eThe generated ID of the workspace that was just created.\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e\n'}),userinput.addEventListener('input',b,!0),suggestions.addEventListener('click',c,!0);function b(){var d,e;const c=5;d=this.value,e=a.search(d,{limit:c,enrich:!0}),suggestions.classList.remove('d-none'),suggestions.innerHTML="";const b={};e.forEach(a=>{a.result.forEach(a=>{b[a.doc.href]=a.doc})});for(const d in b){const e=b[d],a=document.createElement('div');if(a.innerHTML='<a href><span></span><span></span></a>',a.querySelector('a').href=d,a.querySelector('span:first-child').textContent=e.title,a.querySelector('span:nth-child(2)').textContent=e.description,suggestions.appendChild(a),suggestions.childElementCount==c)break}}function c(){while(suggestions.lastChild)suggestions.removeChild(suggestions.lastChild);return!1}})() \ No newline at end of file diff --git a/reference/acm/v1alpha1/certificate/index.html b/reference/acm/v1alpha1/certificate/index.html index 2d426d9c42..1081a1d70e 100644 --- a/reference/acm/v1alpha1/certificate/index.html +++ b/reference/acm/v1alpha1/certificate/index.html @@ -199,4 +199,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The time at which the certificate was requested.</td></tr><tr><td><strong>domainValidations</strong><br>Optional</td><td><strong>array</strong><br>Contains information about the initial validation of each domain name that<br>occurs as a result of the RequestCertificate request. This field exists only<br>when the certificate type is AMAZON_ISSUED.</td></tr><tr><td><strong>domainValidations.[]</strong><br>Required</td><td><strong>object</strong><br>Contains information about the validation of each domain name in the certificate.</td></tr><tr><td><strong>domainValidations.[].resourceRecord</strong><br>Optional</td><td><strong>object</strong><br>Contains a DNS record value that you can use to validate ownership or control<br>of a domain. This is used by the DescribeCertificate action.</td></tr><tr><td><strong>domainValidations.[].resourceRecord.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**domainValidations.[].resourceRecord.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>domainValidations.[].resourceRecord.value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>domainValidations.[].validationDomain</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>domainValidations.[].validationEmails</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>domainValidations.[].validationEmails.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>domainValidations.[].validationStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>extendedKeyUsages</strong><br>Optional</td><td><strong>array</strong><br>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object<br>specifies a purpose for which the certificate public key can be used and<br>consists of a name and an object identifier (OID).</td></tr><tr><td><strong>extendedKeyUsages.[]</strong><br>Required</td><td><strong>object</strong><br>The Extended Key Usage X.509 v3 extension defines one or more purposes for</td></tr><tr><td>which the public key can be used. This is in addition to or in place of the</td><td></td></tr><tr><td>basic purposes specified by the Key Usage extension.</td><td></td></tr><tr><td><strong>extendedKeyUsages.[].oid</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>The reason the certificate request failed. This value exists only when the<br>certificate status is FAILED. For more information, see Certificate Request<br>Failed (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting.html#troubleshooting-failed)<br>in the Certificate Manager User Guide.</td></tr><tr><td><strong>importedAt</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the certificate was imported. This value exists only<br>when the certificate type is IMPORTED.</td></tr><tr><td><strong>inUseBy</strong><br>Optional</td><td><strong>array</strong><br>A list of ARNs for the Amazon Web Services resources that are using the certificate.<br>A certificate can be used by multiple Amazon Web Services resources.</td></tr><tr><td><strong>inUseBy.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>issuer</strong><br>Optional</td><td><strong>string</strong><br>The name of the certificate authority that issued and signed the certificate.</td></tr><tr><td><strong>keyUsages</strong><br>Optional</td><td><strong>array</strong><br>A list of Key Usage X.509 v3 extension objects. Each object is a string value<br>that identifies the purpose of the public key contained in the certificate.<br>Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION,<br>and more.</td></tr><tr><td><strong>keyUsages.[]</strong><br>Required</td><td><strong>object</strong><br>The Key Usage X.509 v3 extension defines the purpose of the public key contained</td></tr><tr><td>in the certificate.</td><td></td></tr><tr><td><strong>notAfter</strong><br>Optional</td><td><strong>string</strong><br>The time after which the certificate is not valid.</td></tr><tr><td><strong>notBefore</strong><br>Optional</td><td><strong>string</strong><br>The time before which the certificate is not valid.</td></tr><tr><td><strong>renewalEligibility</strong><br>Optional</td><td><strong>string</strong><br>Specifies whether the certificate is eligible for renewal. At this time,<br>only exported private certificates can be renewed with the RenewCertificate<br>command.</td></tr><tr><td><strong>renewalSummary</strong><br>Optional</td><td><strong>object</strong><br>Contains information about the status of ACM’s managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)<br>for the certificate. This field exists only when the certificate type is<br>AMAZON_ISSUED.</td></tr><tr><td><strong>renewalSummary.domainValidationOptions</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[]</strong><br>Required</td><td><strong>object</strong><br>Contains information about the validation of each domain name in the certificate.</td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].resourceRecord</strong><br>Optional</td><td><strong>object</strong><br>Contains a DNS record value that you can use to validate ownership or control<br>of a domain. This is used by the DescribeCertificate action.</td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].resourceRecord.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**renewalSummary.domainValidationOptions.[].resourceRecord.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].resourceRecord.value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].validationDomain</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].validationEmails</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].validationEmails.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.domainValidationOptions.[].validationStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.renewalStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.renewalStatusReason</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>renewalSummary.updatedAt</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>revocationReason</strong><br>Optional</td><td><strong>string</strong><br>The reason the certificate was revoked. This value exists only when the certificate<br>status is REVOKED.</td></tr><tr><td><strong>revokedAt</strong><br>Optional</td><td><strong>string</strong><br>The time at which the certificate was revoked. This value exists only when<br>the certificate status is REVOKED.</td></tr><tr><td><strong>serial</strong><br>Optional</td><td><strong>string</strong><br>The serial number of the certificate.</td></tr><tr><td><strong>signatureAlgorithm</strong><br>Optional</td><td><strong>string</strong><br>The algorithm that was used to sign the certificate.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the certificate.<br><br><br>A certificate enters status PENDING_VALIDATION upon being requested, unless<br>it fails for any of the reasons given in the troubleshooting topic Certificate<br>request fails (https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html).<br>ACM makes repeated attempts to validate a certificate for 72 hours and then<br>times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT,<br>delete the request, correct the issue with DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html)<br>or Email validation (https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html),<br>and try again. If validation succeeds, the certificate enters status ISSUED.</td></tr><tr><td><strong>subject</strong><br>Optional</td><td><strong>string</strong><br>The name of the entity that is associated with the public key contained in<br>the certificate.</td></tr><tr><td>**type_**<br>Optional</td><td><strong>string</strong><br>The source of the certificate. For certificates provided by ACM, this value<br>is AMAZON_ISSUED. For certificates that you imported with ImportCertificate,<br>this value is IMPORTED. ACM does not provide managed renewal (https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html)<br>for imported certificates. For more information about the differences between<br>certificates that you import and those that ACM provides, see Importing Certificates<br>(https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html)<br>in the Certificate Manager User Guide.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/acmpca/v1alpha1/certificate/index.html b/reference/acmpca/v1alpha1/certificate/index.html index 1c03698af8..77159e3107 100644 --- a/reference/acmpca/v1alpha1/certificate/index.html +++ b/reference/acmpca/v1alpha1/certificate/index.html @@ -310,4 +310,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/acmpca/v1alpha1/certificateauthority/index.html b/reference/acmpca/v1alpha1/certificateauthority/index.html index b2817ef71d..a840b133a4 100644 --- a/reference/acmpca/v1alpha1/certificateauthority/index.html +++ b/reference/acmpca/v1alpha1/certificateauthority/index.html @@ -232,4 +232,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>csr</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/acmpca/v1alpha1/certificateauthorityactivation/index.html b/reference/acmpca/v1alpha1/certificateauthorityactivation/index.html index cc63ece84c..69cddcf251 100644 --- a/reference/acmpca/v1alpha1/certificateauthorityactivation/index.html +++ b/reference/acmpca/v1alpha1/certificateauthorityactivation/index.html @@ -148,4 +148,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/api/index.html b/reference/apigatewayv2/v1alpha1/api/index.html index 0b99f1e115..434e556368 100644 --- a/reference/apigatewayv2/v1alpha1/api/index.html +++ b/reference/apigatewayv2/v1alpha1/api/index.html @@ -173,4 +173,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>apiEndpoint</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>apiGatewayManaged</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>apiID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>importInfo</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>importInfo.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>warnings.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/authorizer/index.html b/reference/apigatewayv2/v1alpha1/authorizer/index.html index ee62e8097b..1afe9f65af 100644 --- a/reference/apigatewayv2/v1alpha1/authorizer/index.html +++ b/reference/apigatewayv2/v1alpha1/authorizer/index.html @@ -158,4 +158,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>authorizerID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/deployment/index.html b/reference/apigatewayv2/v1alpha1/deployment/index.html index ebce840a58..dddb4c6313 100644 --- a/reference/apigatewayv2/v1alpha1/deployment/index.html +++ b/reference/apigatewayv2/v1alpha1/deployment/index.html @@ -150,4 +150,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>autoDeployed</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>deploymentID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>deploymentStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>deploymentStatusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/integration/index.html b/reference/apigatewayv2/v1alpha1/integration/index.html index b37a1a3fa6..657d2182f1 100644 --- a/reference/apigatewayv2/v1alpha1/integration/index.html +++ b/reference/apigatewayv2/v1alpha1/integration/index.html @@ -167,4 +167,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>apiGatewayManaged</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>integrationID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>integrationResponseSelectionExpression</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/route/index.html b/reference/apigatewayv2/v1alpha1/route/index.html index bd6cf171e6..902f25a8e9 100644 --- a/reference/apigatewayv2/v1alpha1/route/index.html +++ b/reference/apigatewayv2/v1alpha1/route/index.html @@ -163,4 +163,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>apiGatewayManaged</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>routeID</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/stage/index.html b/reference/apigatewayv2/v1alpha1/stage/index.html index 1d8799221a..5ed8cdd468 100644 --- a/reference/apigatewayv2/v1alpha1/stage/index.html +++ b/reference/apigatewayv2/v1alpha1/stage/index.html @@ -167,4 +167,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>apiGatewayManaged</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastDeploymentStatusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastUpdatedDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/apigatewayv2/v1alpha1/vpclink/index.html b/reference/apigatewayv2/v1alpha1/vpclink/index.html index d176071aad..69f4d5efad 100644 --- a/reference/apigatewayv2/v1alpha1/vpclink/index.html +++ b/reference/apigatewayv2/v1alpha1/vpclink/index.html @@ -150,4 +150,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcLinkID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcLinkStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcLinkStatusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcLinkVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/applicationautoscaling/v1alpha1/scalabletarget/index.html b/reference/applicationautoscaling/v1alpha1/scalabletarget/index.html index 19aa4747d9..9a17efab0b 100644 --- a/reference/applicationautoscaling/v1alpha1/scalabletarget/index.html +++ b/reference/applicationautoscaling/v1alpha1/scalabletarget/index.html @@ -151,4 +151,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for when the scalable target was created.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for when the scalable target was created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/applicationautoscaling/v1alpha1/scalingpolicy/index.html b/reference/applicationautoscaling/v1alpha1/scalingpolicy/index.html index a623e50633..1b1681f49b 100644 --- a/reference/applicationautoscaling/v1alpha1/scalingpolicy/index.html +++ b/reference/applicationautoscaling/v1alpha1/scalingpolicy/index.html @@ -201,4 +201,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>alarms</strong><br>Optional</td><td><strong>array</strong><br>The CloudWatch alarms created for the target tracking scaling policy.</td></tr><tr><td><strong>alarms.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a CloudWatch alarm associated with a scaling policy.</td></tr><tr><td><strong>alarms.[].alarmName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for when the scaling policy was created.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for when the scaling policy was created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudfront/v1alpha1/cachepolicy/index.html b/reference/cloudfront/v1alpha1/cachepolicy/index.html index 83b5368406..5bb683b938 100644 --- a/reference/cloudfront/v1alpha1/cachepolicy/index.html +++ b/reference/cloudfront/v1alpha1/cachepolicy/index.html @@ -175,4 +175,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>eTag</strong><br>Optional</td><td><strong>string</strong><br>The current version of the cache policy.</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier for the cache policy.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the cache policy was last modified.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudfront/v1alpha1/distribution/index.html b/reference/cloudfront/v1alpha1/distribution/index.html index c696a42576..6eaa7d6380 100644 --- a/reference/cloudfront/v1alpha1/distribution/index.html +++ b/reference/cloudfront/v1alpha1/distribution/index.html @@ -544,4 +544,4 @@ | <strong>status</strong><br>Optional | <strong>string</strong><br>The distribution’s status. When the status is Deployed, the distribution’s<br>information is fully propagated to all CloudFront edge locations. |</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudfront/v1alpha1/function/index.html b/reference/cloudfront/v1alpha1/function/index.html index 35e3c04fc0..8f38cce199 100644 --- a/reference/cloudfront/v1alpha1/function/index.html +++ b/reference/cloudfront/v1alpha1/function/index.html @@ -156,4 +156,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>eTag</strong><br>Optional</td><td><strong>string</strong><br>The version identifier for the current version of the CloudFront function.</td></tr><tr><td><strong>functionSummary</strong><br>Optional</td><td><strong>object</strong><br>Contains configuration information and metadata about a CloudFront function.</td></tr><tr><td><strong>functionSummary.functionConfig</strong><br>Optional</td><td><strong>object</strong><br>Contains configuration information about a CloudFront function.</td></tr><tr><td><strong>functionSummary.functionConfig.comment</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.functionConfig.runtime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.functionMetadata</strong><br>Optional</td><td><strong>object</strong><br>Contains metadata about a CloudFront function.</td></tr><tr><td><strong>functionSummary.functionMetadata.createdTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.functionMetadata.functionARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.functionMetadata.lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.functionMetadata.stage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionSummary.status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>location</strong><br>Optional</td><td><strong>string</strong><br>The URL of the CloudFront function. Use the URL to manage the function with<br>the CloudFront API.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudfront/v1alpha1/originrequestpolicy/index.html b/reference/cloudfront/v1alpha1/originrequestpolicy/index.html index 88edf4f32f..222869a9a5 100644 --- a/reference/cloudfront/v1alpha1/originrequestpolicy/index.html +++ b/reference/cloudfront/v1alpha1/originrequestpolicy/index.html @@ -170,4 +170,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>eTag</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier for the origin request policy.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the origin request policy was last modified.</td></tr><tr><td><strong>location</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudfront/v1alpha1/responseheaderspolicy/index.html b/reference/cloudfront/v1alpha1/responseheaderspolicy/index.html index 5ce45a09c5..21c5116367 100644 --- a/reference/cloudfront/v1alpha1/responseheaderspolicy/index.html +++ b/reference/cloudfront/v1alpha1/responseheaderspolicy/index.html @@ -203,4 +203,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>eTag</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The identifier for the response headers policy.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the response headers policy was last modified.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudtrail/v1alpha1/eventdatastore/index.html b/reference/cloudtrail/v1alpha1/eventdatastore/index.html index 3be4fd5999..7080c47a8c 100644 --- a/reference/cloudtrail/v1alpha1/eventdatastore/index.html +++ b/reference/cloudtrail/v1alpha1/eventdatastore/index.html @@ -185,4 +185,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdTimestamp</strong><br>Optional</td><td><strong>string</strong><br>The timestamp that shows when the event data store was created.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of event data store creation.</td></tr><tr><td><strong>updatedTimestamp</strong><br>Optional</td><td><strong>string</strong><br>The timestamp that shows when an event data store was updated, if applicable.<br>UpdatedTimestamp is always either the same or newer than the time shown in<br>CreatedTimestamp.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudtrail/v1alpha1/trail/index.html b/reference/cloudtrail/v1alpha1/trail/index.html index 4c84fbe793..c695d4ef29 100644 --- a/reference/cloudtrail/v1alpha1/trail/index.html +++ b/reference/cloudtrail/v1alpha1/trail/index.html @@ -155,4 +155,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>logFileValidationEnabled</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether log file integrity validation is enabled.</td></tr><tr><td><strong>snsTopicARN</strong><br>Optional</td><td><strong>string</strong><br>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications<br>when log files are delivered. The format of a topic ARN is:<br><br><br>arn:aws:sns:us-east-2:123456789012:MyTopic</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudwatch/v1alpha1/metricalarm/index.html b/reference/cloudwatch/v1alpha1/metricalarm/index.html index e5a72fcd4f..6249464ced 100644 --- a/reference/cloudwatch/v1alpha1/metricalarm/index.html +++ b/reference/cloudwatch/v1alpha1/metricalarm/index.html @@ -240,4 +240,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/cloudwatchlogs/v1alpha1/loggroup/index.html b/reference/cloudwatchlogs/v1alpha1/loggroup/index.html index e199fad3cc..eb3ecbc1c1 100644 --- a/reference/cloudwatchlogs/v1alpha1/loggroup/index.html +++ b/reference/cloudwatchlogs/v1alpha1/loggroup/index.html @@ -151,4 +151,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>integer</strong><br>The creation time of the log group, expressed as the number of milliseconds<br>after Jan 1, 1970 00:00:00 UTC.</td></tr><tr><td><strong>dataProtectionStatus</strong><br>Optional</td><td><strong>string</strong><br>Displays whether this log group has a protection policy, or whether it had<br>one in the past. For more information, see PutDataProtectionPolicy (https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutDataProtectionPolicy.html).</td></tr><tr><td><strong>metricFilterCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of metric filters.</td></tr><tr><td><strong>retentionInDays</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>storedBytes</strong><br>Optional</td><td><strong>integer</strong><br>The number of bytes stored.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/common/v1alpha1/adoptedresource/index.html b/reference/common/v1alpha1/adoptedresource/index.html index fda73ae82d..01f66f52af 100644 --- a/reference/common/v1alpha1/adoptedresource/index.html +++ b/reference/common/v1alpha1/adoptedresource/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>conditions</strong><br>Required</td><td><strong>array</strong><br>A collection of <code>ackv1alpha1.Condition</code> objects that describe the various<br>terminal states of the adopted resource CR and its target custom resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/common/v1alpha1/fieldexport/index.html b/reference/common/v1alpha1/fieldexport/index.html index 97823ee20d..9aee2a8a86 100644 --- a/reference/common/v1alpha1/fieldexport/index.html +++ b/reference/common/v1alpha1/fieldexport/index.html @@ -145,4 +145,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>conditions</strong><br>Required</td><td><strong>array</strong><br>A collection of <code>ackv1alpha1.Condition</code> objects that describe the various<br>recoverable states of the field CR</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/documentdb/v1alpha1/dbcluster/index.html b/reference/documentdb/v1alpha1/dbcluster/index.html index 7b234e0555..1d6c83373e 100644 --- a/reference/documentdb/v1alpha1/dbcluster/index.html +++ b/reference/documentdb/v1alpha1/dbcluster/index.html @@ -211,4 +211,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>associatedRoles</strong><br>Optional</td><td><strong>array</strong><br>Provides a list of the Identity and Access Management (IAM) roles that are<br>associated with the cluster. (IAM) roles that are associated with a cluster<br>grant permission for the cluster to access other Amazon Web Services services<br>on your behalf.</td></tr><tr><td><strong>associatedRoles.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an Identity and Access Management (IAM) role that is associated</td></tr><tr><td>with a cluster.</td><td></td></tr><tr><td><strong>associatedRoles.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>cloneGroupID</strong><br>Optional</td><td><strong>string</strong><br>Identifies the clone group to which the DB cluster is associated.</td></tr><tr><td><strong>clusterCreateTime</strong><br>Optional</td><td><strong>string</strong><br>Specifies the time when the cluster was created, in Universal Coordinated<br>Time (UTC).</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>dbClusterMembers</strong><br>Optional</td><td><strong>array</strong><br>Provides the list of instances that make up the cluster.</td></tr><tr><td><strong>dbClusterMembers.[]</strong><br>Required</td><td><strong>object</strong><br>Contains information about an instance that is part of a cluster.</td></tr><tr><td><strong>dbClusterMembers.[].dbInstanceIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbClusterMembers.[].isClusterWriter</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>dbClusterMembers.[].promotionTier</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>dbClusterParameterGroup</strong><br>Optional</td><td><strong>string</strong><br>Specifies the name of the cluster parameter group for the cluster.</td></tr><tr><td><strong>dbClusterResourceID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Web Services Region-unique, immutable identifier for the cluster.<br>This identifier is found in CloudTrail log entries whenever the KMS key for<br>the cluster is accessed.</td></tr><tr><td><strong>dbSubnetGroup</strong><br>Optional</td><td><strong>string</strong><br>Specifies information on the subnet group that is associated with the cluster,<br>including the name, description, and subnets in the subnet group.</td></tr><tr><td><strong>earliestRestorableTime</strong><br>Optional</td><td><strong>string</strong><br>The earliest time to which a database can be restored with point-in-time<br>restore.</td></tr><tr><td><strong>enabledCloudwatchLogsExports</strong><br>Optional</td><td><strong>array</strong><br>A list of log types that this cluster is configured to export to Amazon CloudWatch<br>Logs.</td></tr><tr><td><strong>enabledCloudwatchLogsExports.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>hostedZoneID</strong><br>Optional</td><td><strong>string</strong><br>Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.</td></tr><tr><td><strong>latestRestorableTime</strong><br>Optional</td><td><strong>string</strong><br>Specifies the latest time to which a database can be restored with point-in-time<br>restore.</td></tr><tr><td><strong>multiAZ</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether the cluster has instances in multiple Availability Zones.</td></tr><tr><td><strong>percentProgress</strong><br>Optional</td><td><strong>string</strong><br>Specifies the progress of the operation as a percentage.</td></tr><tr><td><strong>readReplicaIdentifiers</strong><br>Optional</td><td><strong>array</strong><br>Contains one or more identifiers of the secondary clusters that are associated<br>with this cluster.</td></tr><tr><td><strong>readReplicaIdentifiers.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>replicationSourceIdentifier</strong><br>Optional</td><td><strong>string</strong><br>Contains the identifier of the source cluster if this cluster is a secondary<br>cluster.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>Specifies the current state of this cluster.</td></tr><tr><td><strong>vpcSecurityGroups</strong><br>Optional</td><td><strong>array</strong><br>Provides a list of virtual private cloud (VPC) security groups that the cluster<br>belongs to.</td></tr><tr><td><strong>vpcSecurityGroups.[]</strong><br>Required</td><td><strong>object</strong><br>Used as a response element for queries on virtual private cloud (VPC) security</td></tr><tr><td>group membership.</td><td></td></tr><tr><td><strong>vpcSecurityGroups.[].vpcSecurityGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/documentdb/v1alpha1/dbinstance/index.html b/reference/documentdb/v1alpha1/dbinstance/index.html index 4509576b52..1e476847b4 100644 --- a/reference/documentdb/v1alpha1/dbinstance/index.html +++ b/reference/documentdb/v1alpha1/dbinstance/index.html @@ -214,4 +214,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>backupRetentionPeriod</strong><br>Optional</td><td><strong>integer</strong><br>Specifies the number of days for which automatic snapshots are retained.</td></tr><tr><td><strong>certificateDetails</strong><br>Optional</td><td><strong>object</strong><br>The details of the DB instance’s server certificate.</td></tr><tr><td><strong>certificateDetails.cAIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>certificateDetails.validTill</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>dbInstanceStatus</strong><br>Optional</td><td><strong>string</strong><br>Specifies the current state of this database.</td></tr><tr><td><strong>dbSubnetGroup</strong><br>Optional</td><td><strong>object</strong><br>Specifies information on the subnet group that is associated with the instance,<br>including the name, description, and subnets in the subnet group.</td></tr><tr><td><strong>dbSubnetGroup.dbSubnetGroupARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.dbSubnetGroupDescription</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.dbSubnetGroupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.subnetGroupStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.subnets</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>dbSubnetGroup.subnets.[]</strong><br>Required</td><td><strong>object</strong><br>Detailed information about a subnet.</td></tr><tr><td><strong>dbSubnetGroup.subnets.[].subnetAvailabilityZone.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.subnets.[].subnetIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.subnets.[].subnetStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbSubnetGroup.vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>dbiResourceID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Web Services Region-unique, immutable identifier for the instance.<br>This identifier is found in CloudTrail log entries whenever the KMS key for<br>the instance is accessed.</td></tr><tr><td><strong>enabledCloudwatchLogsExports</strong><br>Optional</td><td><strong>array</strong><br>A list of log types that this instance is configured to export to CloudWatch<br>Logs.</td></tr><tr><td><strong>enabledCloudwatchLogsExports.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>endpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>endpoint.hostedZoneID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>endpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>engineVersion</strong><br>Optional</td><td><strong>string</strong><br>Indicates the database engine version.</td></tr><tr><td><strong>instanceCreateTime</strong><br>Optional</td><td><strong>string</strong><br>Provides the date and time that the instance was created.</td></tr><tr><td><strong>kmsKeyID</strong><br>Optional</td><td><strong>string</strong><br>If StorageEncrypted is true, the KMS key identifier for the encrypted instance.</td></tr><tr><td><strong>latestRestorableTime</strong><br>Optional</td><td><strong>string</strong><br>Specifies the latest time to which a database can be restored with point-in-time<br>restore.</td></tr><tr><td><strong>pendingModifiedValues</strong><br>Optional</td><td><strong>object</strong><br>Specifies that changes to the instance are pending. This element is included<br>only when changes are pending. Specific changes are identified by subelements.</td></tr><tr><td><strong>pendingModifiedValues.allocatedStorage</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>pendingModifiedValues.backupRetentionPeriod</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>pendingModifiedValues.caCertificateIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.dbInstanceClass</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.dbInstanceIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.dbSubnetGroupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.engineVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.iops</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>pendingModifiedValues.licenseModel</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.masterUserPassword</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.multiAZ</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>pendingModifiedValues.pendingCloudwatchLogsExports</strong><br>Optional</td><td><strong>object</strong><br>A list of the log types whose configuration is still pending. These log types<br>are in the process of being activated or deactivated.</td></tr><tr><td><strong>pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToDisable.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.pendingCloudwatchLogsExports.logTypesToEnable.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.storageType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>preferredBackupWindow</strong><br>Optional</td><td><strong>string</strong><br>Specifies the daily time range during which automated backups are created<br>if automated backups are enabled, as determined by the BackupRetentionPeriod.</td></tr><tr><td><strong>publiclyAccessible</strong><br>Optional</td><td><strong>boolean</strong><br>Not supported. Amazon DocumentDB does not currently support public endpoints.<br>The value of PubliclyAccessible is always false.</td></tr><tr><td><strong>statusInfos</strong><br>Optional</td><td><strong>array</strong><br>The status of a read replica. If the instance is not a read replica, this<br>is blank.</td></tr><tr><td><strong>statusInfos.[]</strong><br>Required</td><td><strong>object</strong><br>Provides a list of status information for an instance.</td></tr><tr><td><strong>statusInfos.[].normal</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>statusInfos.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>statusInfos.[].statusType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>storageEncrypted</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether or not the instance is encrypted.</td></tr><tr><td><strong>vpcSecurityGroups</strong><br>Optional</td><td><strong>array</strong><br>Provides a list of VPC security group elements that the instance belongs<br>to.</td></tr><tr><td><strong>vpcSecurityGroups.[]</strong><br>Required</td><td><strong>object</strong><br>Used as a response element for queries on virtual private cloud (VPC) security</td></tr><tr><td>group membership.</td><td></td></tr><tr><td><strong>vpcSecurityGroups.[].vpcSecurityGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/documentdb/v1alpha1/dbsubnetgroup/index.html b/reference/documentdb/v1alpha1/dbsubnetgroup/index.html index 6a616ac355..23fa8aa6c8 100644 --- a/reference/documentdb/v1alpha1/dbsubnetgroup/index.html +++ b/reference/documentdb/v1alpha1/dbsubnetgroup/index.html @@ -162,4 +162,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>subnetGroupStatus</strong><br>Optional</td><td><strong>string</strong><br>Provides the status of the subnet group.</td></tr><tr><td><strong>subnets</strong><br>Optional</td><td><strong>array</strong><br>Detailed information about one or more subnets within a subnet group.</td></tr><tr><td><strong>subnets.[]</strong><br>Required</td><td><strong>object</strong><br>Detailed information about a subnet.</td></tr><tr><td><strong>subnets.[].subnetAvailabilityZone.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>Provides the virtual private cloud (VPC) ID of the subnet group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/dynamodb/v1alpha1/backup/index.html b/reference/dynamodb/v1alpha1/backup/index.html index a4bef61d38..7ac5739fc8 100644 --- a/reference/dynamodb/v1alpha1/backup/index.html +++ b/reference/dynamodb/v1alpha1/backup/index.html @@ -145,4 +145,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>backupCreationDateTime</strong><br>Optional</td><td><strong>string</strong><br>Time at which the backup was created. This is the request time of the backup.</td></tr><tr><td><strong>backupExpiryDateTime</strong><br>Optional</td><td><strong>string</strong><br>Time at which the automatic on-demand backup created by DynamoDB will expire.<br>This SYSTEM on-demand backup expires automatically 35 days after its creation.</td></tr><tr><td><strong>backupSizeBytes</strong><br>Optional</td><td><strong>integer</strong><br>Size of the backup in bytes. DynamoDB updates this value approximately every<br>six hours. Recent changes might not be reflected in this value.</td></tr><tr><td><strong>backupStatus</strong><br>Optional</td><td><strong>string</strong><br>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</td></tr><tr><td><strong>backupType</strong><br>Optional</td><td><strong>string</strong><br>BackupType:<br><br><br>* USER - You create and manage these using the on-demand backup feature.<br><br><br>* SYSTEM - If you delete a table with point-in-time recovery enabled,<br>a SYSTEM backup is automatically created and is retained for 35 days (at<br>no additional cost). System backups allow you to restore the deleted table<br>to the state it was in just before the point of deletion.<br><br><br>* AWS_BACKUP - On-demand backup created by you from Backup service.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/dynamodb/v1alpha1/globaltable/index.html b/reference/dynamodb/v1alpha1/globaltable/index.html index 81adb6def9..6c066a0e9e 100644 --- a/reference/dynamodb/v1alpha1/globaltable/index.html +++ b/reference/dynamodb/v1alpha1/globaltable/index.html @@ -144,4 +144,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationDateTime</strong><br>Optional</td><td><strong>string</strong><br>The creation time of the global table.</td></tr><tr><td><strong>globalTableStatus</strong><br>Optional</td><td><strong>string</strong><br>The current state of the global table:<br><br><br>* CREATING - The global table is being created.<br><br><br>* UPDATING - The global table is being updated.<br><br><br>* DELETING - The global table is being deleted.<br><br><br>* ACTIVE - The global table is ready for use.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/dynamodb/v1alpha1/table/index.html b/reference/dynamodb/v1alpha1/table/index.html index c6440b0348..98a1f1fb59 100644 --- a/reference/dynamodb/v1alpha1/table/index.html +++ b/reference/dynamodb/v1alpha1/table/index.html @@ -342,4 +342,4 @@ | <strong>tableStatus</strong><br>Optional | <strong>string</strong><br>The current state of the table:<br><br><br>* CREATING - The table is being created.<br><br><br>* UPDATING - The table/index configuration is being updated. The table/index<br>remains available for data operations when UPDATING.<br><br><br>* DELETING - The table is being deleted.<br><br><br>* ACTIVE - The table is ready for use.<br><br><br>* INACCESSIBLE_ENCRYPTION_CREDENTIALS - The KMS key used to encrypt the<br>table in inaccessible. Table operations may fail due to failure to use<br>the KMS key. DynamoDB will initiate the table archival process when a<br>table’s KMS key remains inaccessible for more than seven days.<br><br><br>* ARCHIVING - The table is being archived. Operations are not allowed<br>until archival is complete.<br><br><br>* ARCHIVED - The table has been archived. See the ArchivalReason for more<br>information. |</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/dhcpoptions/index.html b/reference/ec2/v1alpha1/dhcpoptions/index.html index 98b84933d7..153658b453 100644 --- a/reference/ec2/v1alpha1/dhcpoptions/index.html +++ b/reference/ec2/v1alpha1/dhcpoptions/index.html @@ -155,4 +155,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>dhcpOptionsID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the set of DHCP options.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the DHCP options set.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/elasticipaddress/index.html b/reference/ec2/v1alpha1/elasticipaddress/index.html index e61f5f0882..ace00e2586 100644 --- a/reference/ec2/v1alpha1/elasticipaddress/index.html +++ b/reference/ec2/v1alpha1/elasticipaddress/index.html @@ -149,4 +149,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>allocationID</strong><br>Optional</td><td><strong>string</strong><br>[EC2-VPC] The ID that Amazon Web Services assigns to represent the allocation<br>of the Elastic IP address for use with instances in a VPC.</td></tr><tr><td><strong>carrierIP</strong><br>Optional</td><td><strong>string</strong><br>The carrier IP address. This option is only available for network interfaces<br>which reside in a subnet in a Wavelength Zone (for example an EC2 instance).</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>customerOwnedIP</strong><br>Optional</td><td><strong>string</strong><br>The customer-owned IP address.</td></tr><tr><td><strong>publicIP</strong><br>Optional</td><td><strong>string</strong><br>The Elastic IP address.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/flowlog/index.html b/reference/ec2/v1alpha1/flowlog/index.html index 1b1ef88716..2787bbbeb7 100644 --- a/reference/ec2/v1alpha1/flowlog/index.html +++ b/reference/ec2/v1alpha1/flowlog/index.html @@ -162,4 +162,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>clientToken</strong><br>Optional</td><td><strong>string</strong><br>Unique, case-sensitive identifier that you provide to ensure the idempotency<br>of the request.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>flowLogID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>unsuccessful</strong><br>Optional</td><td><strong>array</strong><br>Information about the flow logs that could not be created successfully.</td></tr><tr><td><strong>unsuccessful.[]</strong><br>Required</td><td><strong>object</strong><br>Information about items that were not successfully processed in a batch call.</td></tr><tr><td><strong>unsuccessful.[].error.code</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>unsuccessful.[].error.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>unsuccessful.[].resourceID</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/instance/index.html b/reference/ec2/v1alpha1/instance/index.html index 4b2a463209..fb3141e481 100644 --- a/reference/ec2/v1alpha1/instance/index.html +++ b/reference/ec2/v1alpha1/instance/index.html @@ -308,4 +308,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>amiLaunchIndex</strong><br>Optional</td><td><strong>integer</strong><br>The AMI launch index, which can be used to find this instance in the launch<br>group.</td></tr><tr><td><strong>architecture</strong><br>Optional</td><td><strong>string</strong><br>The architecture of the image.</td></tr><tr><td><strong>bootMode</strong><br>Optional</td><td><strong>string</strong><br>The boot mode of the instance. For more information, see Boot modes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html)<br>in the Amazon EC2 User Guide.</td></tr><tr><td><strong>capacityReservationID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Capacity Reservation.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>elasticGPUAssociations</strong><br>Optional</td><td><strong>array</strong><br>The Elastic GPU associated with the instance.</td></tr><tr><td><strong>elasticGPUAssociations.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the association between an instance and an Elastic Graphics accelerator.</td></tr><tr><td><strong>elasticGPUAssociations.[].elasticGPUAssociationState</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>elasticGPUAssociations.[].elasticGPUAssociationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>elasticGPUAssociations.[].elasticGPUID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>elasticInferenceAcceleratorAssociations</strong><br>Optional</td><td><strong>array</strong><br>The elastic inference accelerator associated with the instance.</td></tr><tr><td><strong>elasticInferenceAcceleratorAssociations.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the association between an instance and an elastic inference accelerator.</td></tr><tr><td><strong>elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationState</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>elasticInferenceAcceleratorAssociations.[].elasticInferenceAcceleratorAssociationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>enaSupport</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether enhanced networking with ENA is enabled.</td></tr><tr><td><strong>hypervisor</strong><br>Optional</td><td><strong>string</strong><br>The hypervisor type of the instance. The value xen is used for both Xen and<br>Nitro hypervisors.</td></tr><tr><td><strong>instanceID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the instance.</td></tr><tr><td><strong>instanceLifecycle</strong><br>Optional</td><td><strong>string</strong><br>Indicates whether this is a Spot Instance or a Scheduled Instance.</td></tr><tr><td><strong>ipv6Address</strong><br>Optional</td><td><strong>string</strong><br>The IPv6 address assigned to the instance.</td></tr><tr><td><strong>launchTime</strong><br>Optional</td><td><strong>string</strong><br>The time the instance was launched.</td></tr><tr><td><strong>licenses</strong><br>Optional</td><td><strong>array</strong><br>The license configurations for the instance.</td></tr><tr><td><strong>licenses.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a license configuration.</td></tr><tr><td><strong>outpostARN</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Resource Name (ARN) of the Outpost.</td></tr><tr><td><strong>platform</strong><br>Optional</td><td><strong>string</strong><br>The value is Windows for Windows instances; otherwise blank.</td></tr><tr><td><strong>platformDetails</strong><br>Optional</td><td><strong>string</strong><br>The platform details value for the instance. For more information, see AMI<br>billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)<br>in the Amazon EC2 User Guide.</td></tr><tr><td><strong>privateDNSName</strong><br>Optional</td><td><strong>string</strong><br>(IPv4 only) The private DNS hostname name assigned to the instance. This<br>DNS hostname can only be used inside the Amazon EC2 network. This name is<br>not available until the instance enters the running state.<br><br><br>[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private<br>DNS hostnames if you’ve enabled DNS resolution and DNS hostnames in your<br>VPC. If you are not using the Amazon-provided DNS server in your VPC, your<br>custom domain name servers must resolve the hostname as appropriate.</td></tr><tr><td><strong>productCodes</strong><br>Optional</td><td><strong>array</strong><br>The product codes attached to this instance, if applicable.</td></tr><tr><td><strong>productCodes.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a product code.</td></tr><tr><td><strong>productCodes.[].productCodeType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>publicDNSName</strong><br>Optional</td><td><strong>string</strong><br>(IPv4 only) The public DNS name assigned to the instance. This name is not<br>available until the instance enters the running state. For EC2-VPC, this<br>name is only available if you’ve enabled DNS hostnames for your VPC.</td></tr><tr><td><strong>publicIPAddress</strong><br>Optional</td><td><strong>string</strong><br>The public IPv4 address, or the Carrier IP address assigned to the instance,<br>if applicable.<br><br><br>A Carrier IP address only applies to an instance launched in a subnet associated<br>with a Wavelength Zone.</td></tr><tr><td><strong>rootDeviceName</strong><br>Optional</td><td><strong>string</strong><br>The device name of the root device volume (for example, /dev/sda1).</td></tr><tr><td><strong>rootDeviceType</strong><br>Optional</td><td><strong>string</strong><br>The root device type used by the AMI. The AMI can use an EBS volume or an<br>instance store volume.</td></tr><tr><td><strong>sourceDestCheck</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether source/destination checking is enabled.</td></tr><tr><td><strong>spotInstanceRequestID</strong><br>Optional</td><td><strong>string</strong><br>If the request is a Spot Instance request, the ID of the request.</td></tr><tr><td><strong>sriovNetSupport</strong><br>Optional</td><td><strong>string</strong><br>Specifies whether enhanced networking with the Intel 82599 Virtual Function<br>interface is enabled.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>object</strong><br>The current state of the instance.</td></tr><tr><td><strong>state.code</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>state.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>object</strong><br>The reason for the most recent state transition.</td></tr><tr><td><strong>stateReason.code</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>stateReason.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>stateTransitionReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the most recent state transition. This might be an empty string.</td></tr><tr><td><strong>tpmSupport</strong><br>Optional</td><td><strong>string</strong><br>If the instance is configured for NitroTPM support, the value is v2.0. For<br>more information, see NitroTPM (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html)<br>in the Amazon EC2 User Guide.</td></tr><tr><td><strong>usageOperation</strong><br>Optional</td><td><strong>string</strong><br>The usage operation value for the instance. For more information, see AMI<br>billing information fields (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html)<br>in the Amazon EC2 User Guide.</td></tr><tr><td><strong>usageOperationUpdateTime</strong><br>Optional</td><td><strong>string</strong><br>The time that the usage operation was last updated.</td></tr><tr><td><strong>virtualizationType</strong><br>Optional</td><td><strong>string</strong><br>The virtualization type of the instance.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>[EC2-VPC] The ID of the VPC in which the instance is running.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/internetgateway/index.html b/reference/ec2/v1alpha1/internetgateway/index.html index 49da438d81..61a0813948 100644 --- a/reference/ec2/v1alpha1/internetgateway/index.html +++ b/reference/ec2/v1alpha1/internetgateway/index.html @@ -166,4 +166,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>attachments</strong><br>Optional</td><td><strong>array</strong><br>Any VPCs attached to the internet gateway.</td></tr><tr><td><strong>attachments.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the attachment of a VPC to an internet gateway or an egress-only</td></tr><tr><td>internet gateway.</td><td></td></tr><tr><td><strong>attachments.[].vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>internetGatewayID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the internet gateway.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the internet gateway.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/natgateway/index.html b/reference/ec2/v1alpha1/natgateway/index.html index 0fbe5ba18a..915a137071 100644 --- a/reference/ec2/v1alpha1/natgateway/index.html +++ b/reference/ec2/v1alpha1/natgateway/index.html @@ -169,4 +169,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time the NAT gateway was created.</td></tr><tr><td><strong>deleteTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time the NAT gateway was deleted, if applicable.</td></tr><tr><td><strong>failureCode</strong><br>Optional</td><td><strong>string</strong><br>If the NAT gateway could not be created, specifies the error code for the<br>failure. (InsufficientFreeAddressesInSubnet</td></tr><tr><td><strong>failureMessage</strong><br>Optional</td><td><strong>string</strong><br>If the NAT gateway could not be created, specifies the error message for<br>the failure, that corresponds to the error code.<br><br><br>* For InsufficientFreeAddressesInSubnet: “Subnet has insufficient free<br>addresses to create this NAT gateway”<br><br><br>* For Gateway.NotAttached: “Network vpc-xxxxxxxx has no Internet gateway<br>attached”<br><br><br>* For InvalidAllocationID.NotFound: “Elastic IP address eipalloc-xxxxxxxx<br>could not be associated with this NAT gateway”<br><br><br>* For Resource.AlreadyAssociated: “Elastic IP address eipalloc-xxxxxxxx<br>is already associated”<br><br><br>* For InternalError: “Network interface eni-xxxxxxxx, created and used<br>internally by this NAT gateway is in an invalid state. Please try again."<br><br><br>* For InvalidSubnetID.NotFound: “The specified subnet subnet-xxxxxxxx<br>does not exist or could not be found.”</td></tr><tr><td><strong>natGatewayAddresses</strong><br>Optional</td><td><strong>array</strong><br>Information about the IP addresses and network interface associated with<br>the NAT gateway.</td></tr><tr><td><strong>natGatewayAddresses.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the IP addresses and network interface associated with a NAT gateway.</td></tr><tr><td><strong>natGatewayAddresses.[].networkInterfaceID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>natGatewayAddresses.[].privateIP</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>natGatewayAddresses.[].publicIP</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>natGatewayID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the NAT gateway.</td></tr><tr><td><strong>provisionedBandwidth</strong><br>Optional</td><td><strong>object</strong><br>Reserved. If you need to sustain traffic greater than the documented limits<br>(https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html),<br>contact us through the Support Center (https://console.aws.amazon.com/support/home?).</td></tr><tr><td><strong>provisionedBandwidth.provisionTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>provisionedBandwidth.provisioned</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>provisionedBandwidth.requestTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>provisionedBandwidth.requested</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>provisionedBandwidth.status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the NAT gateway.<br><br><br>* pending: The NAT gateway is being created and is not ready to process<br>traffic.<br><br><br>* failed: The NAT gateway could not be created. Check the failureCode<br>and failureMessage fields for the reason.<br><br><br>* available: The NAT gateway is able to process traffic. This status remains<br>until you delete the NAT gateway, and does not indicate the health of<br>the NAT gateway.<br><br><br>* deleting: The NAT gateway is in the process of being terminated and<br>may still be processing traffic.<br><br><br>* deleted: The NAT gateway has been terminated and is no longer processing<br>traffic.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the VPC in which the NAT gateway is located.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/networkacl/index.html b/reference/ec2/v1alpha1/networkacl/index.html index 50e366de45..cf0e3bb3a7 100644 --- a/reference/ec2/v1alpha1/networkacl/index.html +++ b/reference/ec2/v1alpha1/networkacl/index.html @@ -169,4 +169,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ID of the network ACL.</td></tr><tr><td><strong>isDefault</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether this is the default network ACL for the VPC.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the network ACL.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/routetable/index.html b/reference/ec2/v1alpha1/routetable/index.html index 038070df92..2f2cde059a 100644 --- a/reference/ec2/v1alpha1/routetable/index.html +++ b/reference/ec2/v1alpha1/routetable/index.html @@ -206,4 +206,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>associations</strong><br>Optional</td><td><strong>array</strong><br>The associations between the route table and one or more subnets or a gateway.</td></tr><tr><td><strong>associations.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an association between a route table and a subnet or gateway.</td></tr><tr><td><strong>associations.[].associationState.state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>associations.[].associationState.statusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>associations.[].gatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>associations.[].main</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>associations.[].routeTableAssociationID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>associations.[].routeTableID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>associations.[].subnetID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the route table.</td></tr><tr><td><strong>propagatingVGWs</strong><br>Optional</td><td><strong>array</strong><br>Any virtual private gateway (VGW) propagating routes.</td></tr><tr><td><strong>propagatingVGWs.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a virtual private gateway propagating route.</td></tr><tr><td><strong>routeStatuses</strong><br>Optional</td><td><strong>array</strong><br>The routes in the route table.</td></tr><tr><td><strong>routeStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a route in a route table.</td></tr><tr><td><strong>routeStatuses.[].coreNetworkARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].destinationCIDRBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].destinationIPv6CIDRBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].destinationPrefixListID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].egressOnlyInternetGatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].gatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].instanceID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].instanceOwnerID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].localGatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].natGatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].networkInterfaceID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].origin</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].transitGatewayID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeStatuses.[].vpcPeeringConnectionID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>routeTableID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the route table.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/securitygroup/index.html b/reference/ec2/v1alpha1/securitygroup/index.html index a0b1a5b34c..6c3f40cfea 100644 --- a/reference/ec2/v1alpha1/securitygroup/index.html +++ b/reference/ec2/v1alpha1/securitygroup/index.html @@ -245,4 +245,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ID of the security group.</td></tr><tr><td><strong>rules</strong><br>Optional</td><td><strong>array</strong><br>Information about security group rules.</td></tr><tr><td><strong>rules.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a security group rule.</td></tr><tr><td><strong>rules.[].cidrIPv6</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].fromPort</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>rules.[].ipProtocol</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].isEgress</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>rules.[].prefixListID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].securityGroupRuleID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].tags</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>rules.[].tags.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a tag.</td></tr><tr><td><strong>rules.[].tags.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>rules.[].toPort</strong><br>Optional</td><td><strong>integer</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/subnet/index.html b/reference/ec2/v1alpha1/subnet/index.html index 13b851089b..ea56899c57 100644 --- a/reference/ec2/v1alpha1/subnet/index.html +++ b/reference/ec2/v1alpha1/subnet/index.html @@ -191,4 +191,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>availableIPAddressCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of unused private IPv4 addresses in the subnet. The IPv4 addresses<br>for any stopped instances are considered unavailable.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>defaultForAZ</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether this is the default subnet for the Availability Zone.</td></tr><tr><td><strong>enableLniAtDeviceIndex</strong><br>Optional</td><td><strong>integer</strong><br>Indicates the device position for local network interfaces in this subnet.<br>For example, 1 indicates local network interfaces in this subnet are the<br>secondary network interface (eth1).</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet</strong><br>Optional</td><td><strong>array</strong><br>Information about the IPv6 CIDR blocks associated with the subnet.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an association between a subnet and an IPv6 CIDR block.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState</strong><br>Optional</td><td><strong>object</strong><br>Describes the state of a CIDR block.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>mapCustomerOwnedIPOnLaunch</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether a network interface created in this subnet (including a<br>network interface created by RunInstances) receives a customer-owned IPv4<br>address.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the subnet.</td></tr><tr><td><strong>privateDNSNameOptionsOnLaunch</strong><br>Optional</td><td><strong>object</strong><br>The type of hostnames to assign to instances in the subnet at launch. An<br>instance hostname is based on the IPv4 address or ID of the instance.</td></tr><tr><td><strong>privateDNSNameOptionsOnLaunch.enableResourceNameDNSAAAARecord</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>privateDNSNameOptionsOnLaunch.enableResourceNameDNSARecord</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>privateDNSNameOptionsOnLaunch.hostnameType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The current state of the subnet.</td></tr><tr><td><strong>subnetID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the subnet.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/transitgateway/index.html b/reference/ec2/v1alpha1/transitgateway/index.html index c75f81e0df..31da346657 100644 --- a/reference/ec2/v1alpha1/transitgateway/index.html +++ b/reference/ec2/v1alpha1/transitgateway/index.html @@ -157,4 +157,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The creation time.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the transit gateway.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the transit gateway.</td></tr><tr><td><strong>transitGatewayID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the transit gateway.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/vpc/index.html b/reference/ec2/v1alpha1/vpc/index.html index 73f8e0c652..c1f75e1ec8 100644 --- a/reference/ec2/v1alpha1/vpc/index.html +++ b/reference/ec2/v1alpha1/vpc/index.html @@ -174,4 +174,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>cidrBlockAssociationSet</strong><br>Optional</td><td><strong>array</strong><br>Information about the IPv4 CIDR blocks associated with the VPC.</td></tr><tr><td><strong>cidrBlockAssociationSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv4 CIDR block associated with a VPC.</td></tr><tr><td><strong>cidrBlockAssociationSet.[].cidrBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>cidrBlockAssociationSet.[].cidrBlockState</strong><br>Optional</td><td><strong>object</strong><br>Describes the state of a CIDR block.</td></tr><tr><td><strong>cidrBlockAssociationSet.[].cidrBlockState.state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>cidrBlockAssociationSet.[].cidrBlockState.statusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>dhcpOptionsID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the set of DHCP options you’ve associated with the VPC.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet</strong><br>Optional</td><td><strong>array</strong><br>Information about the IPv6 CIDR blocks associated with the VPC.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv6 CIDR block associated with a VPC.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState</strong><br>Optional</td><td><strong>object</strong><br>Describes the state of a CIDR block.</td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6CIDRBlockState.statusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].ipv6Pool</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ipv6CIDRBlockAssociationSet.[].networkBorderGroup</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>isDefault</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether the VPC is the default VPC.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Amazon Web Services account that owns the VPC.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The current state of the VPC.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the VPC.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/vpcendpoint/index.html b/reference/ec2/v1alpha1/vpcendpoint/index.html index fde3cb73f0..6ce4e429d7 100644 --- a/reference/ec2/v1alpha1/vpcendpoint/index.html +++ b/reference/ec2/v1alpha1/vpcendpoint/index.html @@ -211,4 +211,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTimestamp</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the endpoint was created.</td></tr><tr><td><strong>dnsEntries</strong><br>Optional</td><td><strong>array</strong><br>(Interface endpoint) The DNS entries for the endpoint.</td></tr><tr><td><strong>dnsEntries.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a DNS entry.</td></tr><tr><td><strong>dnsEntries.[].hostedZoneID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>groups</strong><br>Optional</td><td><strong>array</strong><br>(Interface endpoint) Information about the security groups that are associated<br>with the network interface.</td></tr><tr><td><strong>groups.[]</strong><br>Required</td><td><strong>object</strong><br>Describes a security group.</td></tr><tr><td><strong>groups.[].groupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastError</strong><br>Optional</td><td><strong>object</strong><br>The last error that occurred for endpoint.</td></tr><tr><td><strong>lastError.code</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastError.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>networkInterfaceIDs</strong><br>Optional</td><td><strong>array</strong><br>(Interface endpoint) One or more network interfaces for the endpoint.</td></tr><tr><td><strong>networkInterfaceIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>requesterManaged</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether the endpoint is being managed by its service.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the endpoint.</td></tr><tr><td><strong>vpcEndpointID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the endpoint.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/index.html b/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/index.html index d06f56e67b..ec0f60cb42 100644 --- a/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/index.html +++ b/reference/ec2/v1alpha1/vpcendpointserviceconfiguration/index.html @@ -167,4 +167,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>availabilityZones</strong><br>Optional</td><td><strong>array</strong><br>The Availability Zones in which the service is available.</td></tr><tr><td><strong>availabilityZones.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>baseEndpointDNSNames.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>managesVPCEndpoints</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether the service manages its VPC endpoints. Management of the<br>service VPC endpoints using the VPC endpoint API is restricted.</td></tr><tr><td><strong>payerResponsibility</strong><br>Optional</td><td><strong>string</strong><br>The payer responsibility.</td></tr><tr><td><strong>privateDNSNameConfiguration</strong><br>Optional</td><td><strong>object</strong><br>Information about the endpoint service private DNS name configuration.</td></tr><tr><td><strong>privateDNSNameConfiguration.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>privateDNSNameConfiguration.state</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**privateDNSNameConfiguration.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>privateDNSNameConfiguration.value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>serviceID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the service.</td></tr><tr><td><strong>serviceName</strong><br>Optional</td><td><strong>string</strong><br>The name of the service.</td></tr><tr><td><strong>serviceState</strong><br>Optional</td><td><strong>string</strong><br>The service state.</td></tr><tr><td><strong>serviceType</strong><br>Optional</td><td><strong>array</strong><br>The type of service.</td></tr><tr><td><strong>serviceType.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the type of service for a VPC endpoint.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ec2/v1alpha1/vpcpeeringconnection/index.html b/reference/ec2/v1alpha1/vpcpeeringconnection/index.html index a9c17731d9..58d7c6c80d 100644 --- a/reference/ec2/v1alpha1/vpcpeeringconnection/index.html +++ b/reference/ec2/v1alpha1/vpcpeeringconnection/index.html @@ -192,4 +192,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>accepterVPCInfo</strong><br>Optional</td><td><strong>object</strong><br>Information about the accepter VPC. CIDR block information is only returned<br>when describing an active VPC peering connection.</td></tr><tr><td><strong>accepterVPCInfo.cidrBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>accepterVPCInfo.cidrBlockSet</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>accepterVPCInfo.cidrBlockSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv4 CIDR block.</td></tr><tr><td><strong>accepterVPCInfo.ipv6CIDRBlockSet</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>accepterVPCInfo.ipv6CIDRBlockSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv6 CIDR block.</td></tr><tr><td><strong>accepterVPCInfo.ownerID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>accepterVPCInfo.peeringOptions</strong><br>Optional</td><td><strong>object</strong><br>We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate<br>from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic<br>to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)<br>in the Amazon Elastic Compute Cloud User Guide.<br><br><br>Describes the VPC peering connection options.</td></tr><tr><td><strong>accepterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>accepterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>accepterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>accepterVPCInfo.region</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>accepterVPCInfo.vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>expirationTime</strong><br>Optional</td><td><strong>string</strong><br>The time that an unaccepted VPC peering connection will expire.</td></tr><tr><td><strong>requesterVPCInfo</strong><br>Optional</td><td><strong>object</strong><br>Information about the requester VPC. CIDR block information is only returned<br>when describing an active VPC peering connection.</td></tr><tr><td><strong>requesterVPCInfo.cidrBlock</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>requesterVPCInfo.cidrBlockSet</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>requesterVPCInfo.cidrBlockSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv4 CIDR block.</td></tr><tr><td><strong>requesterVPCInfo.ipv6CIDRBlockSet</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>requesterVPCInfo.ipv6CIDRBlockSet.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an IPv6 CIDR block.</td></tr><tr><td><strong>requesterVPCInfo.ownerID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>requesterVPCInfo.peeringOptions</strong><br>Optional</td><td><strong>object</strong><br>We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate<br>from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic<br>to a VPC (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html)<br>in the Amazon Elastic Compute Cloud User Guide.<br><br><br>Describes the VPC peering connection options.</td></tr><tr><td><strong>requesterVPCInfo.peeringOptions.allowDNSResolutionFromRemoteVPC</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>requesterVPCInfo.peeringOptions.allowEgressFromLocalClassicLinkToRemoteVPC</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>requesterVPCInfo.peeringOptions.allowEgressFromLocalVPCToRemoteClassicLink</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>requesterVPCInfo.region</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>requesterVPCInfo.vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>object</strong><br>The status of the VPC peering connection.</td></tr><tr><td><strong>status.code</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>status.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcPeeringConnectionID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the VPC peering connection.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ecr/v1alpha1/pullthroughcacherule/index.html b/reference/ecr/v1alpha1/pullthroughcacherule/index.html index 48560b0f10..5db753b40b 100644 --- a/reference/ecr/v1alpha1/pullthroughcacherule/index.html +++ b/reference/ecr/v1alpha1/pullthroughcacherule/index.html @@ -143,4 +143,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in JavaScript date format, when the pull through cache<br>rule was created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ecr/v1alpha1/repository/index.html b/reference/ecr/v1alpha1/repository/index.html index cd005cbe5e..fcac335fd5 100644 --- a/reference/ecr/v1alpha1/repository/index.html +++ b/reference/ecr/v1alpha1/repository/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in JavaScript date format, when the repository was created.</td></tr><tr><td><strong>repositoryURI</strong><br>Optional</td><td><strong>string</strong><br>The URI for the repository. You can use this URI for container image push<br>and pull operations.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ecs/v1alpha1/cluster/index.html b/reference/ecs/v1alpha1/cluster/index.html index 8f2e60e19e..a601a23224 100644 --- a/reference/ecs/v1alpha1/cluster/index.html +++ b/reference/ecs/v1alpha1/cluster/index.html @@ -210,4 +210,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>activeServicesCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of services that are running on the cluster in an ACTIVE state.<br>You can view these services with ListServices.</td></tr><tr><td><strong>attachments</strong><br>Optional</td><td><strong>array</strong><br>The resources attached to a cluster. When using a capacity provider with<br>a cluster, the capacity provider and associated resources are returned as<br>cluster attachments.</td></tr><tr><td><strong>attachments.[]</strong><br>Required</td><td><strong>object</strong><br>An object representing a container instance or task attachment.</td></tr><tr><td><strong>attachments.[].details.[]</strong><br>Required</td><td><strong>object</strong><br>A key-value pair object.</td></tr><tr><td><strong>attachments.[].details.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>attachments.[].id</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>attachments.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>attachments.[].type</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>attachmentsStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the capacity providers associated with the cluster. The following<br>are the states that are returned.<br><br><br>UPDATE_IN_PROGRESS<br><br><br>The available capacity providers for the cluster are updating.<br><br><br>UPDATE_COMPLETE<br><br><br>The capacity providers have successfully updated.<br><br><br>UPDATE_FAILED<br><br><br>The capacity provider updates failed.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>pendingTasksCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of tasks in the cluster that are in the PENDING state.</td></tr><tr><td><strong>registeredContainerInstancesCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of container instances registered into the cluster. This includes<br>container instances in both ACTIVE and DRAINING status.</td></tr><tr><td><strong>runningTasksCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of tasks in the cluster that are in the RUNNING state.</td></tr><tr><td><strong>statistics</strong><br>Optional</td><td><strong>array</strong><br>Additional information about your clusters that are separated by launch type.<br>They include the following:<br><br><br>* runningEC2TasksCount<br><br><br>* RunningFargateTasksCount<br><br><br>* pendingEC2TasksCount<br><br><br>* pendingFargateTasksCount<br><br><br>* activeEC2ServiceCount<br><br><br>* activeFargateServiceCount<br><br><br>* drainingEC2ServiceCount<br><br><br>* drainingFargateServiceCount</td></tr><tr><td><strong>statistics.[]</strong><br>Required</td><td><strong>object</strong><br>A key-value pair object.</td></tr><tr><td><strong>statistics.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the cluster. The following are the possible states that are<br>returned.<br><br><br>ACTIVE<br><br><br>The cluster is ready to accept tasks and if applicable you can register container<br>instances with the cluster.<br><br><br>PROVISIONING<br><br><br>The cluster has capacity providers that are associated with it and the resources<br>needed for the capacity provider are being created.<br><br><br>DEPROVISIONING<br><br><br>The cluster has capacity providers that are associated with it and the resources<br>needed for the capacity provider are being deleted.<br><br><br>FAILED<br><br><br>The cluster has capacity providers that are associated with it and the resources<br>needed for the capacity provider have failed to create.<br><br><br>INACTIVE<br><br><br>The cluster has been deleted. Clusters with an INACTIVE status may remain<br>discoverable in your account for a period of time. However, this behavior<br>is subject to change in the future. We don’t recommend that you rely on INACTIVE<br>clusters persisting.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ecs/v1alpha1/service/index.html b/reference/ecs/v1alpha1/service/index.html index 50804ac510..7e79108258 100644 --- a/reference/ecs/v1alpha1/service/index.html +++ b/reference/ecs/v1alpha1/service/index.html @@ -712,4 +712,4 @@ | <strong>taskSets.[].updatedAt</strong><br>Optional | <strong>string</strong><br>|</p></li></ul><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/ecs/v1alpha1/taskdefinition/index.html b/reference/ecs/v1alpha1/taskdefinition/index.html index 756b7a6abc..178e61f345 100644 --- a/reference/ecs/v1alpha1/taskdefinition/index.html +++ b/reference/ecs/v1alpha1/taskdefinition/index.html @@ -559,4 +559,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>compatibilities</strong><br>Optional</td><td><strong>array</strong><br>The task launch types the task definition validated against during task definition<br>registration. For more information, see Amazon ECS launch types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html)<br>in the Amazon Elastic Container Service Developer Guide.</td></tr><tr><td><strong>compatibilities.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>deregisteredAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for the time when the task definition was deregistered.</td></tr><tr><td><strong>registeredAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix timestamp for the time when the task definition was registered.</td></tr><tr><td><strong>registeredBy</strong><br>Optional</td><td><strong>string</strong><br>The principal that registered the task definition.</td></tr><tr><td><strong>requiresAttributes</strong><br>Optional</td><td><strong>array</strong><br>The container instance attributes required by your task. When an Amazon EC2<br>instance is registered to your cluster, the Amazon ECS container agent assigns<br>some standard attributes to the instance. You can apply custom attributes.<br>These are specified as key-value pairs using the Amazon ECS console or the<br>PutAttributes API. These attributes are used when determining task placement<br>for tasks hosted on Amazon EC2 instances. For more information, see Attributes<br>(https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)<br>in the Amazon Elastic Container Service Developer Guide.<br><br><br>This parameter isn’t supported for tasks run on Fargate.</td></tr><tr><td><strong>requiresAttributes.[]</strong><br>Required</td><td><strong>object</strong><br>An attribute is a name-value pair that’s associated with an Amazon ECS object.</td></tr><tr><td>Use attributes to extend the Amazon ECS data model by adding custom metadata</td><td></td></tr><tr><td>to your resources. For more information, see Attributes (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes)</td><td></td></tr><tr><td>in the Amazon Elastic Container Service Developer Guide.</td><td></td></tr><tr><td><strong>requiresAttributes.[].targetID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>requiresAttributes.[].targetType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>requiresAttributes.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>revision</strong><br>Optional</td><td><strong>integer</strong><br>The revision of the task in a particular family. The revision is a version<br>number of a task definition in a family. When you register a task definition<br>for the first time, the revision is 1. Each time that you register a new<br>revision of a task definition in the same family, the revision value always<br>increases by one. This is even if you deregistered previous revisions in<br>this family.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the task definition.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/efs/v1alpha1/accesspoint/index.html b/reference/efs/v1alpha1/accesspoint/index.html index 139a616486..e7c8627882 100644 --- a/reference/efs/v1alpha1/accesspoint/index.html +++ b/reference/efs/v1alpha1/accesspoint/index.html @@ -161,4 +161,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>accessPointID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the access point, assigned by Amazon EFS.</td></tr><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>lifeCycleState</strong><br>Optional</td><td><strong>string</strong><br>Identifies the lifecycle phase of the access point.</td></tr><tr><td><strong>name</strong><br>Optional</td><td><strong>string</strong><br>The name of the access point. This is the value of the Name tag.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>Identifies the Amazon Web Services account that owns the access point resource.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/efs/v1alpha1/filesystem/index.html b/reference/efs/v1alpha1/filesystem/index.html index fa98a27135..7bc892705c 100644 --- a/reference/efs/v1alpha1/filesystem/index.html +++ b/reference/efs/v1alpha1/filesystem/index.html @@ -187,4 +187,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>availabilityZoneID</strong><br>Optional</td><td><strong>string</strong><br>The unique and consistent identifier of the Availability Zone in which the<br>file system is located, and is valid only for One Zone file systems. For<br>example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web<br>Services Region, and it has the same location in every Amazon Web Services<br>account.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).</td></tr><tr><td><strong>fileSystemID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the file system, assigned by Amazon EFS.</td></tr><tr><td><strong>lifeCycleState</strong><br>Optional</td><td><strong>string</strong><br>The lifecycle phase of the file system.</td></tr><tr><td><strong>name</strong><br>Optional</td><td><strong>string</strong><br>You can add tags to a file system, including a Name tag. For more information,<br>see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns<br>the value in this field.</td></tr><tr><td><strong>numberOfMountTargets</strong><br>Optional</td><td><strong>integer</strong><br>The current number of mount targets that the file system has. For more information,<br>see CreateMountTarget.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Web Services account that created the file system.</td></tr><tr><td><strong>sizeInBytes</strong><br>Optional</td><td><strong>object</strong><br>The latest known metered size (in bytes) of data stored in the file system,<br>in its Value field, and the time at which that size was determined in its<br>Timestamp field. The Timestamp value is the integer number of seconds since<br>1970-01-01T00:00:00Z. The SizeInBytes value doesn’t represent the size of<br>a consistent snapshot of the file system, but it is eventually consistent<br>when there are no writes to the file system. That is, SizeInBytes represents<br>actual size only if the file system is not modified for a period longer than<br>a couple of hours. Otherwise, the value is not the exact size that the file<br>system was at any point in time.</td></tr><tr><td><strong>sizeInBytes.timestamp</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>sizeInBytes.value</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>sizeInBytes.valueInArchive</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>sizeInBytes.valueInIA</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>sizeInBytes.valueInStandard</strong><br>Optional</td><td><strong>integer</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/efs/v1alpha1/mounttarget/index.html b/reference/efs/v1alpha1/mounttarget/index.html index 2f917906e7..bf83ed546c 100644 --- a/reference/efs/v1alpha1/mounttarget/index.html +++ b/reference/efs/v1alpha1/mounttarget/index.html @@ -166,4 +166,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>availabilityZoneID</strong><br>Optional</td><td><strong>string</strong><br>The unique and consistent identifier of the Availability Zone that the mount<br>target resides in. For example, use1-az1 is an AZ ID for the us-east-1 Region<br>and it has the same location in every Amazon Web Services account.</td></tr><tr><td><strong>availabilityZoneName</strong><br>Optional</td><td><strong>string</strong><br>The name of the Availability Zone in which the mount target is located. Availability<br>Zones are independently mapped to names for each Amazon Web Services account.<br>For example, the Availability Zone us-east-1a for your Amazon Web Services<br>account might not be the same location as us-east-1a for another Amazon Web<br>Services account.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>lifeCycleState</strong><br>Optional</td><td><strong>string</strong><br>Lifecycle state of the mount target.</td></tr><tr><td><strong>mountTargetID</strong><br>Optional</td><td><strong>string</strong><br>System-assigned mount target ID.</td></tr><tr><td><strong>networkInterfaceID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the network interface that Amazon EFS created when it created the<br>mount target.</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>Amazon Web Services account ID that owns the resource.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The virtual private cloud (VPC) ID that the mount target is configured in.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/accessentry/index.html b/reference/eks/v1alpha1/accessentry/index.html index 13b918ef6b..268f929d00 100644 --- a/reference/eks/v1alpha1/accessentry/index.html +++ b/reference/eks/v1alpha1/accessentry/index.html @@ -160,4 +160,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp at object creation.</td></tr><tr><td><strong>modifiedAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp for the last modification to the object.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/addon/index.html b/reference/eks/v1alpha1/addon/index.html index 05434e4238..cae6ba1ce5 100644 --- a/reference/eks/v1alpha1/addon/index.html +++ b/reference/eks/v1alpha1/addon/index.html @@ -168,4 +168,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp at object creation.</td></tr><tr><td><strong>health</strong><br>Optional</td><td><strong>object</strong><br>An object that represents the health of the add-on.</td></tr><tr><td><strong>health.issues</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[]</strong><br>Required</td><td><strong>object</strong><br>An issue related to an add-on.</td></tr><tr><td><strong>health.issues.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>marketplaceInformation.productID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>marketplaceInformation.productURL</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>modifiedAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp for the last modification to the object.</td></tr><tr><td><strong>owner</strong><br>Optional</td><td><strong>string</strong><br>The owner of the add-on.</td></tr><tr><td><strong>publisher</strong><br>Optional</td><td><strong>string</strong><br>The publisher of the add-on.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the add-on.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/cluster/index.html b/reference/eks/v1alpha1/cluster/index.html index be2d646ec4..ef56b301e8 100644 --- a/reference/eks/v1alpha1/cluster/index.html +++ b/reference/eks/v1alpha1/cluster/index.html @@ -225,4 +225,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>certificateAuthority</strong><br>Optional</td><td><strong>object</strong><br>The certificate-authority-data for your cluster.</td></tr><tr><td><strong>certificateAuthority.data</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>connectorConfig</strong><br>Optional</td><td><strong>object</strong><br>The configuration used to connect to a cluster for registration.</td></tr><tr><td><strong>connectorConfig.activationCode</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>connectorConfig.activationExpiry</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>connectorConfig.activationID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>connectorConfig.provider</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>connectorConfig.roleARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp at object creation.</td></tr><tr><td><strong>endpoint</strong><br>Optional</td><td><strong>string</strong><br>The endpoint for your Kubernetes API server.</td></tr><tr><td><strong>health</strong><br>Optional</td><td><strong>object</strong><br>An object representing the health of your local Amazon EKS cluster on an<br>Amazon Web Services Outpost. This object isn’t available for clusters on<br>the Amazon Web Services cloud.</td></tr><tr><td><strong>health.issues</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[]</strong><br>Required</td><td><strong>object</strong><br>An issue with your local Amazon EKS cluster on an Amazon Web Services Outpost.</td></tr><tr><td>You can’t use this API with an Amazon EKS cluster on the Amazon Web Services</td><td></td></tr><tr><td>cloud.</td><td></td></tr><tr><td><strong>health.issues.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>identity</strong><br>Optional</td><td><strong>object</strong><br>The identity provider information for the cluster.</td></tr><tr><td><strong>identity.oidc</strong><br>Optional</td><td><strong>object</strong><br>An object representing the OpenID Connect (https://openid.net/connect/) (OIDC)<br>identity provider information for the cluster.</td></tr><tr><td><strong>identity.oidc.issuer</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>platformVersion</strong><br>Optional</td><td><strong>string</strong><br>The platform version of your Amazon EKS cluster. For more information about<br>clusters deployed on the Amazon Web Services Cloud, see Platform versions<br>(https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html)<br>in the Amazon EKS User Guide . For more information about local clusters<br>deployed on an Outpost, see Amazon EKS local cluster platform versions (https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html)<br>in the Amazon EKS User Guide .</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current status of the cluster.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/fargateprofile/index.html b/reference/eks/v1alpha1/fargateprofile/index.html index bfbbd8a13b..e29360ad13 100644 --- a/reference/eks/v1alpha1/fargateprofile/index.html +++ b/reference/eks/v1alpha1/fargateprofile/index.html @@ -164,4 +164,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp at object creation.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current status of the Fargate profile.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/nodegroup/index.html b/reference/eks/v1alpha1/nodegroup/index.html index 396cdce4ae..196713703b 100644 --- a/reference/eks/v1alpha1/nodegroup/index.html +++ b/reference/eks/v1alpha1/nodegroup/index.html @@ -224,4 +224,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The Unix epoch timestamp at object creation.</td></tr><tr><td><strong>health</strong><br>Optional</td><td><strong>object</strong><br>The health status of the node group. If there are issues with your node group’s<br>health, they are listed here.</td></tr><tr><td><strong>health.issues</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[]</strong><br>Required</td><td><strong>object</strong><br>An object representing an issue with an Amazon EKS resource.</td></tr><tr><td><strong>health.issues.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>health.issues.[].resourceIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>resources</strong><br>Optional</td><td><strong>object</strong><br>The resources associated with the node group, such as Auto Scaling groups<br>and security groups for remote access.</td></tr><tr><td><strong>resources.autoScalingGroups</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>resources.autoScalingGroups.[]</strong><br>Required</td><td><strong>object</strong><br>An Auto Scaling group that is associated with an Amazon EKS managed node</td></tr><tr><td>group.</td><td></td></tr><tr><td><strong>resources.remoteAccessSecurityGroup</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current status of the managed node group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eks/v1alpha1/podidentityassociation/index.html b/reference/eks/v1alpha1/podidentityassociation/index.html index c23ed05002..7f7616b70e 100644 --- a/reference/eks/v1alpha1/podidentityassociation/index.html +++ b/reference/eks/v1alpha1/podidentityassociation/index.html @@ -156,4 +156,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>associationARN</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Resource Name (ARN) of the association.</td></tr><tr><td><strong>associationID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the association.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdAt</strong><br>Optional</td><td><strong>string</strong><br>The timestamp that the association was created at.</td></tr><tr><td><strong>modifiedAt</strong><br>Optional</td><td><strong>string</strong><br>The most recent timestamp that the association was modified at</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/cacheparametergroup/index.html b/reference/elasticache/v1alpha1/cacheparametergroup/index.html index 1ec6cbb95f..49099d096d 100644 --- a/reference/elasticache/v1alpha1/cacheparametergroup/index.html +++ b/reference/elasticache/v1alpha1/cacheparametergroup/index.html @@ -164,4 +164,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>isGlobal</strong><br>Optional</td><td><strong>boolean</strong><br>Indicates whether the parameter group is associated with a Global datastore</td></tr><tr><td><strong>parameters</strong><br>Optional</td><td><strong>array</strong><br>A list of Parameter instances.</td></tr><tr><td><strong>parameters.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an individual setting that controls some aspect of ElastiCache behavior.</td></tr><tr><td><strong>parameters.[].changeType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].dataType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].isModifiable</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>parameters.[].minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].parameterName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].parameterValue</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].source</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/cachesubnetgroup/index.html b/reference/elasticache/v1alpha1/cachesubnetgroup/index.html index b7b24649ad..ecd0a514a3 100644 --- a/reference/elasticache/v1alpha1/cachesubnetgroup/index.html +++ b/reference/elasticache/v1alpha1/cachesubnetgroup/index.html @@ -161,4 +161,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets</strong><br>Optional</td><td><strong>array</strong><br>A list of subnets associated with the cache subnet group.</td></tr><tr><td><strong>subnets.[]</strong><br>Required</td><td><strong>object</strong><br>Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.</td></tr><tr><td><strong>subnets.[].subnetAvailabilityZone.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetOutpost</strong><br>Optional</td><td><strong>object</strong><br>The ID of the outpost subnet.</td></tr><tr><td><strong>subnets.[].subnetOutpost.subnetOutpostARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/replicationgroup/index.html b/reference/elasticache/v1alpha1/replicationgroup/index.html index 334e5c5fa2..63e0a41962 100644 --- a/reference/elasticache/v1alpha1/replicationgroup/index.html +++ b/reference/elasticache/v1alpha1/replicationgroup/index.html @@ -287,4 +287,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>allowedScaleDownModifications</strong><br>Optional</td><td><strong>array</strong><br>A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group. When scaling down a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.</td></tr><tr><td><strong>allowedScaleDownModifications.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>allowedScaleUpModifications.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>authTokenLastModifiedDate</strong><br>Optional</td><td><strong>string</strong><br>The date the auth token was last modified</td></tr><tr><td><strong>autoMinorVersionUpgrade</strong><br>Optional</td><td><strong>boolean</strong><br>If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.</td></tr><tr><td><strong>automaticFailover</strong><br>Optional</td><td><strong>string</strong><br>Indicates the status of automatic failover for this Redis replication group.</td></tr><tr><td><strong>clusterEnabled</strong><br>Optional</td><td><strong>boolean</strong><br>A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).<br>Valid values: true</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>configurationEndpoint</strong><br>Optional</td><td><strong>object</strong><br>The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.</td></tr><tr><td><strong>configurationEndpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>configurationEndpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>dataTiering</strong><br>Optional</td><td><strong>string</strong><br>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>globalReplicationGroupInfo</strong><br>Optional</td><td><strong>object</strong><br>The name of the Global datastore and role of this replication group in the Global datastore.</td></tr><tr><td><strong>globalReplicationGroupInfo.globalReplicationGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>globalReplicationGroupInfo.globalReplicationGroupMemberRole</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations</strong><br>Optional</td><td><strong>array</strong><br>Returns the destination, format and type of the logs.</td></tr><tr><td><strong>logDeliveryConfigurations.[]</strong><br>Required</td><td><strong>object</strong><br>Returns the destination, format and type of the logs.</td></tr><tr><td><strong>logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails</strong><br>Optional</td><td><strong>object</strong><br>The configuration details of the CloudWatch Logs destination.</td></tr><tr><td><strong>logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails</strong><br>Optional</td><td><strong>object</strong><br>The configuration details of the Kinesis Data Firehose destination.</td></tr><tr><td><strong>logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].destinationType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].logFormat</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].logType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>logDeliveryConfigurations.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>memberClusters</strong><br>Optional</td><td><strong>array</strong><br>The names of all the cache clusters that are part of this replication group.</td></tr><tr><td><strong>memberClusters.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>memberClustersOutpostARNs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups</strong><br>Optional</td><td><strong>array</strong><br>A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).</td></tr><tr><td><strong>nodeGroups.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.</td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single node within a node group (shard).</td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].cacheNodeID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].currentRole</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].preferredAvailabilityZone</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].preferredOutpostARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].readEndpoint</strong><br>Optional</td><td><strong>object</strong><br>Represents the information required for client programs to connect to a cache node.</td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].readEndpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].nodeGroupMembers.[].readEndpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>nodeGroups.[].primaryEndpoint</strong><br>Optional</td><td><strong>object</strong><br>Represents the information required for client programs to connect to a cache node.</td></tr><tr><td><strong>nodeGroups.[].primaryEndpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].primaryEndpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>nodeGroups.[].readerEndpoint</strong><br>Optional</td><td><strong>object</strong><br>Represents the information required for client programs to connect to a cache node.</td></tr><tr><td><strong>nodeGroups.[].readerEndpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].readerEndpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>nodeGroups.[].slots</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeGroups.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues</strong><br>Optional</td><td><strong>object</strong><br>A group of settings to be applied to the replication group, either immediately or during the next maintenance window.</td></tr><tr><td><strong>pendingModifiedValues.authTokenStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.automaticFailoverStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[]</strong><br>Required</td><td><strong>object</strong><br>The log delivery configurations being modified</td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails</strong><br>Optional</td><td><strong>object</strong><br>The configuration details of the CloudWatch Logs destination.</td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.cloudWatchLogsDetails.logGroup</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails</strong><br>Optional</td><td><strong>object</strong><br>The configuration details of the Kinesis Data Firehose destination.</td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].destinationDetails.kinesisFirehoseDetails.deliveryStream</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].destinationType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].logFormat</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.logDeliveryConfigurations.[].logType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.primaryClusterID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.resharding</strong><br>Optional</td><td><strong>object</strong><br>The status of an online resharding operation.</td></tr><tr><td><strong>pendingModifiedValues.resharding.slotMigration</strong><br>Optional</td><td><strong>object</strong><br>Represents the progress of an online resharding operation.</td></tr><tr><td><strong>pendingModifiedValues.resharding.slotMigration.progressPercentage</strong><br>Optional</td><td><strong>number</strong><br></td></tr><tr><td><strong>pendingModifiedValues.userGroups</strong><br>Optional</td><td><strong>object</strong><br>The status of the user group update.</td></tr><tr><td><strong>pendingModifiedValues.userGroups.userGroupIDsToAdd</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingModifiedValues.userGroups.userGroupIDsToAdd.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingModifiedValues.userGroups.userGroupIDsToRemove.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>snapshottingClusterID</strong><br>Optional</td><td><strong>string</strong><br>The cluster ID that is used as the daily snapshot source for the replication group.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/snapshot/index.html b/reference/elasticache/v1alpha1/snapshot/index.html index 7aef9f3d4f..6e635da8f6 100644 --- a/reference/elasticache/v1alpha1/snapshot/index.html +++ b/reference/elasticache/v1alpha1/snapshot/index.html @@ -186,4 +186,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>autoMinorVersionUpgrade</strong><br>Optional</td><td><strong>boolean</strong><br>If you are running Redis engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next auto minor version upgrade campaign. This parameter is disabled for previous versions.</td></tr><tr><td><strong>automaticFailover</strong><br>Optional</td><td><strong>string</strong><br>Indicates the status of automatic failover for the source Redis replication group.</td></tr><tr><td><strong>cacheClusterCreateTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the source cluster was created.</td></tr><tr><td><strong>cacheNodeType</strong><br>Optional</td><td><strong>string</strong><br>The name of the compute and memory capacity node type for the source cluster.<br>The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.<br>* General purpose: Current generation: M6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.m6g.large, cache.m6g.xlarge, cache.m6g.2xlarge, cache.m6g.4xlarge, cache.m6g.8xlarge, cache.m6g.12xlarge, cache.m6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge T4g node types (available only for Redis engine version 5.0.6 onward and Memcached engine version 1.5.16 onward): cache.t4g.micro, cache.t4g.small, cache.t4g.medium T3 node types: cache.t3.micro, cache.t3.small, cache.t3.medium T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) T1 node types: cache.t1.micro M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge<br>* Compute optimized: Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) C1 node types: cache.c1.xlarge<br>* Memory optimized with data tiering: Current generation: R6gd node types (available only for Redis engine version 6.2 onward). cache.r6gd.xlarge, cache.r6gd.2xlarge, cache.r6gd.4xlarge, cache.r6gd.8xlarge, cache.r6gd.12xlarge, cache.r6gd.16xlarge<br>* Memory optimized: Current generation: R6g node types (available only for Redis engine version 5.0.6 onward and for Memcached engine version 1.5.16 onward). cache.r6g.large, cache.r6g.xlarge, cache.r6g.2xlarge, cache.r6g.4xlarge, cache.r6g.8xlarge, cache.r6g.12xlarge, cache.r6g.16xlarge For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) For region availability, see Supported Node Types (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html#CacheNodes.SupportedTypesByRegion) R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge Previous generation: (not recommended. Existing clusters are still supported but creation of new clusters is not supported for these types.) M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge<br>Additional node type info<br>* All current generation instance types are created in Amazon VPC by default.<br>* Redis append-only files (AOF) are not supported for T1 or T2 instances.<br>* Redis Multi-AZ with automatic failover is not supported on T1 instances.<br>* Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.</td></tr><tr><td><strong>cacheParameterGroupName</strong><br>Optional</td><td><strong>string</strong><br>The cache parameter group that is associated with the source cluster.</td></tr><tr><td><strong>cacheSubnetGroupName</strong><br>Optional</td><td><strong>string</strong><br>The name of the cache subnet group associated with the source cluster.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>dataTiering</strong><br>Optional</td><td><strong>string</strong><br>Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see Data tiering (https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/data-tiering.html).</td></tr><tr><td><strong>engine</strong><br>Optional</td><td><strong>string</strong><br>The name of the cache engine (memcached or redis) used by the source cluster.</td></tr><tr><td><strong>engineVersion</strong><br>Optional</td><td><strong>string</strong><br>The version of the cache engine version that is used by the source cluster.</td></tr><tr><td><strong>nodeSnapshots</strong><br>Optional</td><td><strong>array</strong><br>A list of the cache nodes in the source cluster.</td></tr><tr><td><strong>nodeSnapshots.[]</strong><br>Required</td><td><strong>object</strong><br>Represents an individual cache node in a snapshot of a cluster.</td></tr><tr><td><strong>nodeSnapshots.[].cacheNodeCreateTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].cacheNodeID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].cacheSize</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration</strong><br>Optional</td><td><strong>object</strong><br>Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.</td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.nodeGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.primaryAvailabilityZone</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.primaryOutpostARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.replicaAvailabilityZones.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupConfiguration.replicaOutpostARNs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].nodeGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>nodeSnapshots.[].snapshotCreateTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>numCacheNodes</strong><br>Optional</td><td><strong>integer</strong><br>The number of cache nodes in the source cluster.<br>For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 40.</td></tr><tr><td><strong>numNodeGroups</strong><br>Optional</td><td><strong>integer</strong><br>The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.</td></tr><tr><td><strong>port</strong><br>Optional</td><td><strong>integer</strong><br>The port number used by each cache nodes in the source cluster.</td></tr><tr><td><strong>preferredAvailabilityZone</strong><br>Optional</td><td><strong>string</strong><br>The name of the Availability Zone in which the source cluster is located.</td></tr><tr><td><strong>preferredMaintenanceWindow</strong><br>Optional</td><td><strong>string</strong><br>Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.<br>Valid values for ddd are:<br>* sun<br>* mon<br>* tue<br>* wed<br>* thu<br>* fri<br>* sat<br>Example: sun:23:00-mon:01:30</td></tr><tr><td><strong>preferredOutpostARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN (Amazon Resource Name) of the preferred outpost.</td></tr><tr><td><strong>replicationGroupDescription</strong><br>Optional</td><td><strong>string</strong><br>A description of the source replication group.</td></tr><tr><td><strong>snapshotRetentionLimit</strong><br>Optional</td><td><strong>integer</strong><br>For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.<br>For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.<br>Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.</td></tr><tr><td><strong>snapshotSource</strong><br>Optional</td><td><strong>string</strong><br>Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).</td></tr><tr><td><strong>snapshotStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the snapshot. Valid values: creating</td></tr><tr><td><strong>snapshotWindow</strong><br>Optional</td><td><strong>string</strong><br>The daily time range during which ElastiCache takes daily snapshots of the source cluster.</td></tr><tr><td><strong>topicARN</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/user/index.html b/reference/elasticache/v1alpha1/user/index.html index 9ea7955f8c..9611f2d819 100644 --- a/reference/elasticache/v1alpha1/user/index.html +++ b/reference/elasticache/v1alpha1/user/index.html @@ -159,4 +159,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>authentication</strong><br>Optional</td><td><strong>object</strong><br>Denotes whether the user requires a password to authenticate.</td></tr><tr><td><strong>authentication.passwordCount</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td>**authentication.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>expandedAccessString</strong><br>Optional</td><td><strong>string</strong><br>Access permissions string used for this user.</td></tr><tr><td><strong>lastRequestedAccessString</strong><br>Optional</td><td><strong>string</strong><br>Access permissions string used for this user.</td></tr><tr><td><strong>minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br>The minimum engine version required, which is Redis 6.0</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>Indicates the user status. Can be “active”, “modifying” or “deleting”.</td></tr><tr><td><strong>userGroupIDs</strong><br>Optional</td><td><strong>array</strong><br>Returns a list of the user group IDs the user belongs to.</td></tr><tr><td><strong>userGroupIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/elasticache/v1alpha1/usergroup/index.html b/reference/elasticache/v1alpha1/usergroup/index.html index 67f48e051e..8a24763e3a 100644 --- a/reference/elasticache/v1alpha1/usergroup/index.html +++ b/reference/elasticache/v1alpha1/usergroup/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br>The minimum engine version required, which is Redis 6.0</td></tr><tr><td><strong>pendingChanges</strong><br>Optional</td><td><strong>object</strong><br>A list of updates being applied to the user group.</td></tr><tr><td><strong>pendingChanges.userIDsToAdd</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingChanges.userIDsToAdd.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingChanges.userIDsToRemove.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>replicationGroups.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/emrcontainers/v1alpha1/jobrun/index.html b/reference/emrcontainers/v1alpha1/jobrun/index.html index fa70ede2af..e25c0444ff 100644 --- a/reference/emrcontainers/v1alpha1/jobrun/index.html +++ b/reference/emrcontainers/v1alpha1/jobrun/index.html @@ -157,4 +157,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>This output displays the started job run ID.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the job run.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/emrcontainers/v1alpha1/virtualcluster/index.html b/reference/emrcontainers/v1alpha1/virtualcluster/index.html index 101ce7f34f..af0aecf26a 100644 --- a/reference/emrcontainers/v1alpha1/virtualcluster/index.html +++ b/reference/emrcontainers/v1alpha1/virtualcluster/index.html @@ -153,4 +153,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>This output contains the virtual cluster ID.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eventbridge/v1alpha1/archive/index.html b/reference/eventbridge/v1alpha1/archive/index.html index 53221ecc48..30ae4cd9ec 100644 --- a/reference/eventbridge/v1alpha1/archive/index.html +++ b/reference/eventbridge/v1alpha1/archive/index.html @@ -150,4 +150,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time at which the archive was created.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the archive that was created.</td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>string</strong><br>The reason that the archive is in the state.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eventbridge/v1alpha1/endpoint/index.html b/reference/eventbridge/v1alpha1/endpoint/index.html index fdc9c6d7e0..20f11083cd 100644 --- a/reference/eventbridge/v1alpha1/endpoint/index.html +++ b/reference/eventbridge/v1alpha1/endpoint/index.html @@ -157,4 +157,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the endpoint that was created by this request.</td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>string</strong><br>The reason the endpoint you asked for information about is in its current<br>state.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eventbridge/v1alpha1/eventbus/index.html b/reference/eventbridge/v1alpha1/eventbus/index.html index 47c0c708fe..8d324916bf 100644 --- a/reference/eventbridge/v1alpha1/eventbus/index.html +++ b/reference/eventbridge/v1alpha1/eventbus/index.html @@ -149,4 +149,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/eventbridge/v1alpha1/rule/index.html b/reference/eventbridge/v1alpha1/rule/index.html index 5580f0e4c9..8b09fd6d77 100644 --- a/reference/eventbridge/v1alpha1/rule/index.html +++ b/reference/eventbridge/v1alpha1/rule/index.html @@ -316,4 +316,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/group/index.html b/reference/iam/v1alpha1/group/index.html index 36464f3eb6..6fb7c67874 100644 --- a/reference/iam/v1alpha1/group/index.html +++ b/reference/iam/v1alpha1/group/index.html @@ -153,4 +153,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the group was created.</td></tr><tr><td><strong>groupID</strong><br>Optional</td><td><strong>string</strong><br>The stable and unique string identifying the group. For more information<br>about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)<br>in the IAM User Guide.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/instanceprofile/index.html b/reference/iam/v1alpha1/instanceprofile/index.html index 2e6a7dc056..0812930d58 100644 --- a/reference/iam/v1alpha1/instanceprofile/index.html +++ b/reference/iam/v1alpha1/instanceprofile/index.html @@ -152,4 +152,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createDate</strong><br>Optional</td><td><strong>string</strong><br>The date when the instance profile was created.</td></tr><tr><td><strong>instanceProfileID</strong><br>Optional</td><td><strong>string</strong><br>The stable and unique string identifying the instance profile. For more information<br>about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)<br>in the IAM User Guide.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/openidconnectprovider/index.html b/reference/iam/v1alpha1/openidconnectprovider/index.html index 72612d8c34..065d7c3b8c 100644 --- a/reference/iam/v1alpha1/openidconnectprovider/index.html +++ b/reference/iam/v1alpha1/openidconnectprovider/index.html @@ -146,4 +146,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/policy/index.html b/reference/iam/v1alpha1/policy/index.html index d53ea76399..e6496a6e24 100644 --- a/reference/iam/v1alpha1/policy/index.html +++ b/reference/iam/v1alpha1/policy/index.html @@ -157,4 +157,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>attachmentCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of entities (users, groups, and roles) that the policy is attached<br>to.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the policy was created.</td></tr><tr><td><strong>defaultVersionID</strong><br>Optional</td><td><strong>string</strong><br>The identifier for the version of the policy that is set as the default version.</td></tr><tr><td><strong>isAttachable</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether the policy can be attached to an IAM user, group, or role.</td></tr><tr><td><strong>permissionsBoundaryUsageCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of entities (users and roles) for which the policy is used to<br>set the permissions boundary.<br><br><br>For more information about permissions boundaries, see Permissions boundaries<br>for IAM identities (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html)<br>in the IAM User Guide.</td></tr><tr><td><strong>policyID</strong><br>Optional</td><td><strong>string</strong><br>The stable and unique string identifying the policy.<br><br><br>For more information about IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)<br>in the IAM User Guide.</td></tr><tr><td><strong>updateDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the policy was last updated.<br><br><br>When a policy has only one version, this field contains the date and time<br>when the policy was created. When a policy has more than one version, this<br>field contains the date and time when the most recent policy version was<br>created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/role/index.html b/reference/iam/v1alpha1/role/index.html index e62ef8b942..036e9bc670 100644 --- a/reference/iam/v1alpha1/role/index.html +++ b/reference/iam/v1alpha1/role/index.html @@ -171,4 +171,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the role was created.</td></tr><tr><td><strong>roleID</strong><br>Optional</td><td><strong>string</strong><br>The stable and unique string identifying the role. For more information about<br>IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)<br>in the IAM User Guide.</td></tr><tr><td><strong>roleLastUsed</strong><br>Optional</td><td><strong>object</strong><br>Contains information about the last time that an IAM role was used. This<br>includes the date and time and the Region in which the role was last used.<br>Activity is only reported for the trailing 400 days. This period can be shorter<br>if your Region began supporting these features within the last year. The<br>role might have been used more than 400 days ago. For more information, see<br>Regions where data is tracked (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period)<br>in the IAM user Guide.</td></tr><tr><td><strong>roleLastUsed.lastUsedDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>roleLastUsed.region</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/iam/v1alpha1/user/index.html b/reference/iam/v1alpha1/user/index.html index c64c30106f..7087f5339a 100644 --- a/reference/iam/v1alpha1/user/index.html +++ b/reference/iam/v1alpha1/user/index.html @@ -167,4 +167,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the user was created.</td></tr><tr><td><strong>passwordLastUsed</strong><br>Optional</td><td><strong>string</strong><br>The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),<br>when the user’s password was last used to sign in to an Amazon Web Services<br>website. For a list of Amazon Web Services websites that capture a user’s<br>last sign-in time, see the Credential reports (https://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html)<br>topic in the IAM User Guide. If a password is used more than once in a five-minute<br>span, only the first use is returned in this field. If the field is null<br>(no value), then it indicates that they never signed in with a password.<br>This can be because:<br><br><br>* The user never had a password.<br><br><br>* A password exists but has not been used since IAM started tracking this<br>information on October 20, 2014.<br><br><br>A null value does not mean that the user never had a password. Also, if the<br>user does not currently have a password but had one in the past, then this<br>field contains the date and time the most recent password was used.<br><br><br>This value is returned only in the GetUser and ListUsers operations.</td></tr><tr><td><strong>userID</strong><br>Optional</td><td><strong>string</strong><br>The stable and unique string identifying the user. For more information about<br>IDs, see IAM identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)<br>in the IAM User Guide.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/index.html b/reference/index.html index 00fc09db81..39884a4e2f 100644 --- a/reference/index.html +++ b/reference/index.html @@ -277,4 +277,4 @@ <small>v1alpha1</small></div></ul></div></div></article></div></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/kafka/v1alpha1/cluster/index.html b/reference/kafka/v1alpha1/cluster/index.html index 729f501571..5e53cde540 100644 --- a/reference/kafka/v1alpha1/cluster/index.html +++ b/reference/kafka/v1alpha1/cluster/index.html @@ -202,4 +202,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the cluster. The possible states are ACTIVE, CREATING, DELETING,<br>FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/keyspaces/v1alpha1/keyspace/index.html b/reference/keyspaces/v1alpha1/keyspace/index.html index c189b49467..3056ee7be4 100644 --- a/reference/keyspaces/v1alpha1/keyspace/index.html +++ b/reference/keyspaces/v1alpha1/keyspace/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>resourceARN</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier of the keyspace in the format of an Amazon Resource<br>Name (ARN).</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/keyspaces/v1alpha1/table/index.html b/reference/keyspaces/v1alpha1/table/index.html index 70ad3d653d..6459ca5a26 100644 --- a/reference/keyspaces/v1alpha1/table/index.html +++ b/reference/keyspaces/v1alpha1/table/index.html @@ -180,4 +180,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/kinesis/v1alpha1/stream/index.html b/reference/kinesis/v1alpha1/stream/index.html index 0dc6fcce94..a0930dddb7 100644 --- a/reference/kinesis/v1alpha1/stream/index.html +++ b/reference/kinesis/v1alpha1/stream/index.html @@ -152,4 +152,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>consumerCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of enhanced fan-out consumers registered with the stream.</td></tr><tr><td><strong>encryptionType</strong><br>Optional</td><td><strong>string</strong><br>The encryption type used. This value is one of the following:<br><br><br>* KMS<br><br><br>* NONE</td></tr><tr><td><strong>enhancedMonitoring</strong><br>Optional</td><td><strong>array</strong><br>Represents the current enhanced monitoring settings of the stream.</td></tr><tr><td><strong>enhancedMonitoring.[]</strong><br>Required</td><td><strong>object</strong><br>Represents enhanced metrics types.</td></tr><tr><td><strong>enhancedMonitoring.[].shardLevelMetrics.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>openShardCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of open shards in the stream.</td></tr><tr><td><strong>retentionPeriodHours</strong><br>Optional</td><td><strong>integer</strong><br>The current retention period, in hours.</td></tr><tr><td><strong>streamCreationTimestamp</strong><br>Optional</td><td><strong>string</strong><br>The approximate time that the stream was created.</td></tr><tr><td><strong>streamStatus</strong><br>Optional</td><td><strong>string</strong><br>The current status of the stream being described. The stream status is one<br>of the following states:<br><br><br>* CREATING - The stream is being created. Kinesis Data Streams immediately<br>returns and sets StreamStatus to CREATING.<br><br><br>* DELETING - The stream is being deleted. The specified stream is in the<br>DELETING state until Kinesis Data Streams completes the deletion.<br><br><br>* ACTIVE - The stream exists and is ready for read and write operations<br>or deletion. You should perform read and write operations only on an ACTIVE<br>stream.<br><br><br>* UPDATING - Shards in the stream are being merged or split. Read and<br>write operations continue to work while the stream is in the UPDATING<br>state.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/kms/v1alpha1/alias/index.html b/reference/kms/v1alpha1/alias/index.html index c42f1f2cc3..61e56e6866 100644 --- a/reference/kms/v1alpha1/alias/index.html +++ b/reference/kms/v1alpha1/alias/index.html @@ -143,4 +143,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/kms/v1alpha1/grant/index.html b/reference/kms/v1alpha1/grant/index.html index 2e140903d1..24c55836b0 100644 --- a/reference/kms/v1alpha1/grant/index.html +++ b/reference/kms/v1alpha1/grant/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>grantID</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier for the grant.<br><br><br>You can use the GrantId in a ListGrants, RetireGrant, or RevokeGrant operation.</td></tr><tr><td><strong>grantToken</strong><br>Optional</td><td><strong>string</strong><br>The grant token.<br><br><br>Use a grant token when your permission to call this operation comes from<br>a new grant that has not yet achieved eventual consistency. For more information,<br>see Grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token)<br>and Using a grant token (https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token)<br>in the Key Management Service Developer Guide.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/kms/v1alpha1/key/index.html b/reference/kms/v1alpha1/key/index.html index 2aba839b7c..3d8be0ca04 100644 --- a/reference/kms/v1alpha1/key/index.html +++ b/reference/kms/v1alpha1/key/index.html @@ -178,4 +178,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>awsAccountID</strong><br>Optional</td><td><strong>string</strong><br>The twelve-digit account ID of the Amazon Web Services account that owns<br>the KMS key.</td></tr><tr><td><strong>cloudHsmClusterID</strong><br>Optional</td><td><strong>string</strong><br>The cluster ID of the CloudHSM cluster that contains the key material for<br>the KMS key. When you create a KMS key in a custom key store (https://docs.aws.amazon.com/kms/latest/developerguide/custom-key-store-overview.html),<br>KMS creates the key material for the KMS key in the associated CloudHSM cluster.<br>This value is present only when the KMS key is created in a custom key store.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the KMS key was created.</td></tr><tr><td><strong>deletionDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time after which KMS deletes this KMS key. This value is present<br>only when the KMS key is scheduled for deletion, that is, when its KeyState<br>is PendingDeletion.<br><br><br>When the primary key in a multi-Region key is scheduled for deletion but<br>still has replica keys, its key state is PendingReplicaDeletion and the length<br>of its waiting period is displayed in the PendingDeletionWindowInDays field.</td></tr><tr><td><strong>enabled</strong><br>Optional</td><td><strong>boolean</strong><br>Specifies whether the KMS key is enabled. When KeyState is Enabled this value<br>is true, otherwise it is false.</td></tr><tr><td><strong>encryptionAlgorithms</strong><br>Optional</td><td><strong>array</strong><br>The encryption algorithms that the KMS key supports. You cannot use the KMS<br>key with other encryption algorithms within KMS.<br><br><br>This value is present only when the KeyUsage of the KMS key is ENCRYPT_DECRYPT.</td></tr><tr><td><strong>encryptionAlgorithms.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>keyID</strong><br>Optional</td><td><strong>string</strong><br>The globally unique identifier for the KMS key.</td></tr><tr><td><strong>keyManager</strong><br>Optional</td><td><strong>string</strong><br>The manager of the KMS key. KMS keys in your Amazon Web Services account<br>are either customer managed or Amazon Web Services managed. For more information<br>about the difference, see KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys)<br>in the Key Management Service Developer Guide.</td></tr><tr><td><strong>keyState</strong><br>Optional</td><td><strong>string</strong><br>The current status of the KMS key.<br><br><br>For more information about how key state affects the use of a KMS key, see<br>Key states of KMS keys (https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html)<br>in the Key Management Service Developer Guide.</td></tr><tr><td><strong>macAlgorithms</strong><br>Optional</td><td><strong>array</strong><br>The message authentication code (MAC) algorithm that the HMAC KMS key supports.<br><br><br>This value is present only when the KeyUsage of the KMS key is GENERATE_VERIFY_MAC.</td></tr><tr><td><strong>macAlgorithms.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>multiRegionConfiguration.multiRegionKeyType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>multiRegionConfiguration.primaryKey</strong><br>Optional</td><td><strong>object</strong><br>Describes the primary or replica key in a multi-Region key.</td></tr><tr><td><strong>multiRegionConfiguration.primaryKey.arn</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>multiRegionConfiguration.primaryKey.region</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>multiRegionConfiguration.replicaKeys</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>multiRegionConfiguration.replicaKeys.[]</strong><br>Required</td><td><strong>object</strong><br>Describes the primary or replica key in a multi-Region key.</td></tr><tr><td><strong>multiRegionConfiguration.replicaKeys.[].region</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingDeletionWindowInDays</strong><br>Optional</td><td><strong>integer</strong><br>The waiting period before the primary key in a multi-Region key is deleted.<br>This waiting period begins when the last of its replica keys is deleted.<br>This value is present only when the KeyState of the KMS key is PendingReplicaDeletion.<br>That indicates that the KMS key is the primary key in a multi-Region key,<br>it is scheduled for deletion, and it still has existing replica keys.<br><br><br>When a single-Region KMS key or a multi-Region replica key is scheduled for<br>deletion, its deletion date is displayed in the DeletionDate field. However,<br>when the primary key in a multi-Region key is scheduled for deletion, its<br>waiting period doesn’t begin until all of its replica keys are deleted. This<br>value displays that waiting period. When the last replica key in the multi-Region<br>key is deleted, the KeyState of the scheduled primary key changes from PendingReplicaDeletion<br>to PendingDeletion and the deletion date appears in the DeletionDate field.</td></tr><tr><td><strong>signingAlgorithms</strong><br>Optional</td><td><strong>array</strong><br>The signing algorithms that the KMS key supports. You cannot use the KMS<br>key with other signing algorithms within KMS.<br><br><br>This field appears only when the KeyUsage of the KMS key is SIGN_VERIFY.</td></tr><tr><td><strong>signingAlgorithms.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/alias/index.html b/reference/lambda/v1alpha1/alias/index.html index d56d6993a0..8e811fce4e 100644 --- a/reference/lambda/v1alpha1/alias/index.html +++ b/reference/lambda/v1alpha1/alias/index.html @@ -162,4 +162,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>revisionID</strong><br>Optional</td><td><strong>string</strong><br>A unique identifier that changes when you update the alias.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/codesigningconfig/index.html b/reference/lambda/v1alpha1/codesigningconfig/index.html index 74fdb3f015..a7fe23dca4 100644 --- a/reference/lambda/v1alpha1/codesigningconfig/index.html +++ b/reference/lambda/v1alpha1/codesigningconfig/index.html @@ -147,4 +147,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>codeSigningConfigID</strong><br>Optional</td><td><strong>string</strong><br>Unique identifer for the Code signing configuration.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>lastModified</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the Code signing configuration was last modified,<br>in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/eventsourcemapping/index.html b/reference/lambda/v1alpha1/eventsourcemapping/index.html index 3f4f6912e0..98f622f3a1 100644 --- a/reference/lambda/v1alpha1/eventsourcemapping/index.html +++ b/reference/lambda/v1alpha1/eventsourcemapping/index.html @@ -207,4 +207,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>functionARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the Lambda function.</td></tr><tr><td><strong>lastModified</strong><br>Optional</td><td><strong>string</strong><br>The date that the event source mapping was last updated or that its state<br>changed.</td></tr><tr><td><strong>lastProcessingResult</strong><br>Optional</td><td><strong>string</strong><br>The result of the last Lambda invocation of your function.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The state of the event source mapping. It can be one of the following: Creating,<br>Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.</td></tr><tr><td><strong>stateTransitionReason</strong><br>Optional</td><td><strong>string</strong><br>Indicates whether a user or Lambda made the last change to the event source<br>mapping.</td></tr><tr><td><strong>uuid</strong><br>Optional</td><td><strong>string</strong><br>The identifier of the event source mapping.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/function/index.html b/reference/lambda/v1alpha1/function/index.html index 7021424c24..dac7c12de6 100644 --- a/reference/lambda/v1alpha1/function/index.html +++ b/reference/lambda/v1alpha1/function/index.html @@ -249,4 +249,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>codeSHA256</strong><br>Optional</td><td><strong>string</strong><br>The SHA256 hash of the function’s deployment package.</td></tr><tr><td><strong>codeSize</strong><br>Optional</td><td><strong>integer</strong><br>The size of the function’s deployment package, in bytes.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>imageConfigResponse</strong><br>Optional</td><td><strong>object</strong><br>The function’s image configuration values.</td></tr><tr><td><strong>imageConfigResponse.error</strong><br>Optional</td><td><strong>object</strong><br>Error response to GetFunctionConfiguration.</td></tr><tr><td><strong>imageConfigResponse.error.errorCode</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.error.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig</strong><br>Optional</td><td><strong>object</strong><br>Configuration values that override the container image Dockerfile settings.<br>For more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).</td></tr><tr><td><strong>imageConfigResponse.imageConfig.command</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig.command.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig.entryPoint.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastModified</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the function was last updated, in ISO-8601 format<br>(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).</td></tr><tr><td><strong>lastUpdateStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the last update that was performed on the function. This is<br>first set to Successful after function creation completes.</td></tr><tr><td><strong>lastUpdateStatusReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the last update that was performed on the function.</td></tr><tr><td><strong>lastUpdateStatusReasonCode</strong><br>Optional</td><td><strong>string</strong><br>The reason code for the last update that was performed on the function.</td></tr><tr><td><strong>layerStatuses</strong><br>Optional</td><td><strong>array</strong><br>The function’s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).</td></tr><tr><td><strong>layerStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).</td></tr><tr><td><strong>layerStatuses.[].codeSize</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>layerStatuses.[].signingJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>layerStatuses.[].signingProfileVersionARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>masterARN</strong><br>Optional</td><td><strong>string</strong><br>For Lambda@Edge functions, the ARN of the main function.</td></tr><tr><td><strong>revisionID</strong><br>Optional</td><td><strong>string</strong><br>The latest updated revision of the function or alias.</td></tr><tr><td><strong>signingJobARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the signing job.</td></tr><tr><td><strong>signingProfileVersionARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the signing profile version.</td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The current state of the function. When the state is Inactive, you can reactivate<br>the function by invoking it.</td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the function’s current state.</td></tr><tr><td><strong>stateReasonCode</strong><br>Optional</td><td><strong>string</strong><br>The reason code for the function’s current state. When the code is Creating,<br>you can’t invoke or modify the function.</td></tr><tr><td><strong>version</strong><br>Optional</td><td><strong>string</strong><br>The version of the Lambda function.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/functionurlconfig/index.html b/reference/lambda/v1alpha1/functionurlconfig/index.html index 21cc5196e2..66bd0d3377 100644 --- a/reference/lambda/v1alpha1/functionurlconfig/index.html +++ b/reference/lambda/v1alpha1/functionurlconfig/index.html @@ -159,4 +159,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>When the function URL was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)<br>(YYYY-MM-DDThh:mm:ss.sTZD).</td></tr><tr><td><strong>functionARN</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Resource Name (ARN) of your function.</td></tr><tr><td><strong>functionURL</strong><br>Optional</td><td><strong>string</strong><br>The HTTP URL endpoint for your function.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/layerversion/index.html b/reference/lambda/v1alpha1/layerversion/index.html index 7364b45511..85b5df1e0c 100644 --- a/reference/lambda/v1alpha1/layerversion/index.html +++ b/reference/lambda/v1alpha1/layerversion/index.html @@ -153,4 +153,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br>The date that the layer version was created, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)<br>(YYYY-MM-DDThh:mm:ss.sTZD).</td></tr><tr><td><strong>layerARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the layer.</td></tr><tr><td><strong>versionNumber</strong><br>Optional</td><td><strong>integer</strong><br>The version number.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/lambda/v1alpha1/version/index.html b/reference/lambda/v1alpha1/version/index.html index a15a47a740..2d64a697fe 100644 --- a/reference/lambda/v1alpha1/version/index.html +++ b/reference/lambda/v1alpha1/version/index.html @@ -220,4 +220,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>architectures</strong><br>Optional</td><td><strong>array</strong><br>The instruction set architecture that the function supports. Architecture<br>is a string array with one of the valid values. The default architecture<br>value is x86_64.</td></tr><tr><td><strong>architectures.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>deadLetterConfig</strong><br>Optional</td><td><strong>object</strong><br>The function’s dead letter queue.</td></tr><tr><td><strong>deadLetterConfig.targetARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>environment</strong><br>Optional</td><td><strong>object</strong><br>The function’s environment variables (https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).<br>Omitted from CloudTrail logs.</td></tr><tr><td><strong>environment.error</strong><br>Optional</td><td><strong>object</strong><br>Error messages for environment variables that couldn’t be applied.</td></tr><tr><td><strong>environment.error.errorCode</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>environment.error.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>environment.variables</strong><br>Optional</td><td><strong>object</strong><br></td></tr><tr><td><strong>ephemeralStorage</strong><br>Optional</td><td><strong>object</strong><br>The size of the function’s /tmp directory in MB. The default value is 512,<br>but it can be any whole number between 512 and 10,240 MB.</td></tr><tr><td><strong>ephemeralStorage.size</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>fileSystemConfigs</strong><br>Optional</td><td><strong>array</strong><br>Connection settings for an Amazon EFS file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).</td></tr><tr><td><strong>fileSystemConfigs.[]</strong><br>Required</td><td><strong>object</strong><br>Details about the connection between a Lambda function and an Amazon EFS</td></tr><tr><td>file system (https://docs.aws.amazon.com/lambda/latest/dg/configuration-filesystem.html).</td><td></td></tr><tr><td><strong>fileSystemConfigs.[].localMountPath</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>functionARN</strong><br>Optional</td><td><strong>string</strong><br>The function’s Amazon Resource Name (ARN).</td></tr><tr><td><strong>handler</strong><br>Optional</td><td><strong>string</strong><br>The function that Lambda calls to begin running your function.</td></tr><tr><td><strong>imageConfigResponse</strong><br>Optional</td><td><strong>object</strong><br>The function’s image configuration values.</td></tr><tr><td><strong>imageConfigResponse.error</strong><br>Optional</td><td><strong>object</strong><br>Error response to GetFunctionConfiguration.</td></tr><tr><td><strong>imageConfigResponse.error.errorCode</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.error.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig</strong><br>Optional</td><td><strong>object</strong><br>Configuration values that override the container image Dockerfile settings.<br>For more information, see Container image settings (https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms).</td></tr><tr><td><strong>imageConfigResponse.imageConfig.command</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig.command.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>imageConfigResponse.imageConfig.entryPoint.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>kmsKeyARN</strong><br>Optional</td><td><strong>string</strong><br>The KMS key that’s used to encrypt the function’s environment variables.<br>This key is returned only if you’ve configured a customer managed key.</td></tr><tr><td><strong>lastModified</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the function was last updated, in ISO-8601 format<br>(https://www.w3.org/TR/NOTE-datetime) (YYYY-MM-DDThh:mm:ss.sTZD).</td></tr><tr><td><strong>lastUpdateStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the last update that was performed on the function. This is<br>first set to Successful after function creation completes.</td></tr><tr><td><strong>lastUpdateStatusReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the last update that was performed on the function.</td></tr><tr><td><strong>lastUpdateStatusReasonCode</strong><br>Optional</td><td><strong>string</strong><br>The reason code for the last update that was performed on the function.</td></tr><tr><td><strong>layers</strong><br>Optional</td><td><strong>array</strong><br>The function’s layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).</td></tr><tr><td><strong>layers.[]</strong><br>Required</td><td><strong>object</strong><br>An Lambda layer (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html).</td></tr><tr><td><strong>layers.[].codeSize</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>layers.[].signingJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>layers.[].signingProfileVersionARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>masterARN</strong><br>Optional</td><td><strong>string</strong><br>For Lambda@Edge functions, the ARN of the main function.</td></tr><tr><td><strong>memorySize</strong><br>Optional</td><td><strong>integer</strong><br>The amount of memory available to the function at runtime.</td></tr><tr><td><strong>packageType</strong><br>Optional</td><td><strong>string</strong><br>The type of deployment package. Set to Image for container image and set<br>Zip for .zip file archive.</td></tr><tr><td><strong>qualifier</strong><br>Optional</td><td><strong>string</strong><br>The version of the Lambda function.</td></tr><tr><td><strong>role</strong><br>Optional</td><td><strong>string</strong><br>The function’s execution role.</td></tr><tr><td><strong>runtime</strong><br>Optional</td><td><strong>string</strong><br>The runtime environment for the Lambda function.</td></tr><tr><td><strong>signingJobARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the signing job.</td></tr><tr><td><strong>signingProfileVersionARN</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the signing profile version.</td></tr><tr><td><strong>snapStart</strong><br>Optional</td><td><strong>object</strong><br>Set ApplyOn to PublishedVersions to create a snapshot of the initialized<br>execution environment when you publish a function version. For more information,<br>see Improving startup performance with Lambda SnapStart (https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html).</td></tr><tr><td><strong>snapStart.applyOn</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>snapStart.optimizationStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>state</strong><br>Optional</td><td><strong>string</strong><br>The current state of the function. When the state is Inactive, you can reactivate<br>the function by invoking it.</td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the function’s current state.</td></tr><tr><td><strong>stateReasonCode</strong><br>Optional</td><td><strong>string</strong><br>The reason code for the function’s current state. When the code is Creating,<br>you can’t invoke or modify the function.</td></tr><tr><td><strong>timeout</strong><br>Optional</td><td><strong>integer</strong><br>The amount of time in seconds that Lambda allows a function to run before<br>stopping it.</td></tr><tr><td><strong>tracingConfig</strong><br>Optional</td><td><strong>object</strong><br>The function’s X-Ray tracing configuration.</td></tr><tr><td><strong>tracingConfig.mode</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>version</strong><br>Optional</td><td><strong>string</strong><br>The version of the Lambda function.</td></tr><tr><td><strong>vpcConfig</strong><br>Optional</td><td><strong>object</strong><br>The function’s networking configuration.</td></tr><tr><td><strong>vpcConfig.securityGroupIDs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>vpcConfig.securityGroupIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcConfig.subnetIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/acl/index.html b/reference/memorydb/v1alpha1/acl/index.html index 38f6fc123e..aafc4e7051 100644 --- a/reference/memorydb/v1alpha1/acl/index.html +++ b/reference/memorydb/v1alpha1/acl/index.html @@ -161,4 +161,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>clusters</strong><br>Optional</td><td><strong>array</strong><br>A list of clusters associated with the ACL.</td></tr><tr><td><strong>clusters.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br>The minimum engine version supported for the ACL</td></tr><tr><td><strong>pendingChanges</strong><br>Optional</td><td><strong>object</strong><br>A list of updates being applied to the ACL.</td></tr><tr><td><strong>pendingChanges.userNamesToAdd</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingChanges.userNamesToAdd.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingChanges.userNamesToRemove.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/cluster/index.html b/reference/memorydb/v1alpha1/cluster/index.html index 62f1b3b35b..61df68b1eb 100644 --- a/reference/memorydb/v1alpha1/cluster/index.html +++ b/reference/memorydb/v1alpha1/cluster/index.html @@ -225,4 +225,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>allowedScaleDownNodeTypes</strong><br>Optional</td><td><strong>array</strong><br>A list node types which you can use to scale down your cluster.</td></tr><tr><td><strong>allowedScaleDownNodeTypes.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>allowedScaleUpNodeTypes.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterEndpoint</strong><br>Optional</td><td><strong>object</strong><br>The cluster’s configuration endpoint</td></tr><tr><td><strong>clusterEndpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterEndpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>enginePatchVersion</strong><br>Optional</td><td><strong>string</strong><br>The Redis engine patch version used by the cluster</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>numberOfShards</strong><br>Optional</td><td><strong>integer</strong><br>The number of shards in the cluster</td></tr><tr><td><strong>parameterGroupStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the parameter group used by the cluster, for example ‘active’ or ‘applying’.</td></tr><tr><td><strong>pendingUpdates</strong><br>Optional</td><td><strong>object</strong><br>A group of settings that are currently being applied.</td></tr><tr><td><strong>pendingUpdates.acls</strong><br>Optional</td><td><strong>object</strong><br>The status of the ACL update</td></tr><tr><td><strong>pendingUpdates.acls.aclToApply</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingUpdates.resharding</strong><br>Optional</td><td><strong>object</strong><br>The status of the online resharding</td></tr><tr><td><strong>pendingUpdates.resharding.slotMigration</strong><br>Optional</td><td><strong>object</strong><br>Represents the progress of an online resharding operation.</td></tr><tr><td><strong>pendingUpdates.resharding.slotMigration.progressPercentage</strong><br>Optional</td><td><strong>number</strong><br></td></tr><tr><td><strong>pendingUpdates.serviceUpdates</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>pendingUpdates.serviceUpdates.[]</strong><br>Required</td><td><strong>object</strong><br>Update action that has yet to be processed for the corresponding apply/stop request</td></tr><tr><td><strong>pendingUpdates.serviceUpdates.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>securityGroups</strong><br>Optional</td><td><strong>array</strong><br>A list of security groups used by the cluster</td></tr><tr><td><strong>securityGroups.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single security group and its status.</td></tr><tr><td><strong>securityGroups.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards</strong><br>Optional</td><td><strong>array</strong><br>A list of shards that are members of the cluster.</td></tr><tr><td><strong>shards.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a collection of nodes in a cluster. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.</td></tr><tr><td><strong>shards.[].nodes</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>shards.[].nodes.[]</strong><br>Required</td><td><strong>object</strong><br>Represents an individual node within a cluster. Each node runs its own instance of the cluster’s protocol-compliant caching software.</td></tr><tr><td><strong>shards.[].nodes.[].createTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards.[].nodes.[].endpoint</strong><br>Optional</td><td><strong>object</strong><br>Represents the information required for client programs to connect to the cluster and its nodes.</td></tr><tr><td><strong>shards.[].nodes.[].endpoint.address</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards.[].nodes.[].endpoint.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>shards.[].nodes.[].name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards.[].nodes.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards.[].numberOfNodes</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>shards.[].slots</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>shards.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>snsTopicStatus</strong><br>Optional</td><td><strong>string</strong><br>The SNS topic must be in Active status to receive notifications</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the cluster. For example, Available, Updating, Creating.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/parametergroup/index.html b/reference/memorydb/v1alpha1/parametergroup/index.html index 5d81b3a114..ac90772ca9 100644 --- a/reference/memorydb/v1alpha1/parametergroup/index.html +++ b/reference/memorydb/v1alpha1/parametergroup/index.html @@ -154,4 +154,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>parameters</strong><br>Optional</td><td><strong>array</strong><br>A list of parameters specific to a particular parameter group. Each element in the list contains detailed information about one parameter.</td></tr><tr><td><strong>parameters.[]</strong><br>Required</td><td><strong>object</strong><br>Describes an individual setting that controls some aspect of MemoryDB behavior.</td></tr><tr><td><strong>parameters.[].dataType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>parameters.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/snapshot/index.html b/reference/memorydb/v1alpha1/snapshot/index.html index 4c53614eb1..13ba24c7e2 100644 --- a/reference/memorydb/v1alpha1/snapshot/index.html +++ b/reference/memorydb/v1alpha1/snapshot/index.html @@ -175,4 +175,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>clusterConfiguration</strong><br>Optional</td><td><strong>object</strong><br>The configuration of the cluster from which the snapshot was taken</td></tr><tr><td><strong>clusterConfiguration.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.engineVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.maintenanceWindow</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.nodeType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.numShards</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>clusterConfiguration.parameterGroupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.port</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards.[]</strong><br>Required</td><td><strong>object</strong><br>Provides details of a shard in a snapshot</td></tr><tr><td><strong>clusterConfiguration.shards.[].configuration.replicaCount</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards.[].configuration.slots</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards.[].name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards.[].size</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.shards.[].snapshotCreationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.snapshotRetentionLimit</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>clusterConfiguration.snapshotWindow</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.subnetGroupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.topicARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>clusterConfiguration.vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>source</strong><br>Optional</td><td><strong>string</strong><br>Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status of the snapshot. Valid values: creating</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/subnetgroup/index.html b/reference/memorydb/v1alpha1/subnetgroup/index.html index a64b8dde9f..6787008c5d 100644 --- a/reference/memorydb/v1alpha1/subnetgroup/index.html +++ b/reference/memorydb/v1alpha1/subnetgroup/index.html @@ -155,4 +155,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>subnets</strong><br>Optional</td><td><strong>array</strong><br>A list of subnets associated with the subnet group.</td></tr><tr><td><strong>subnets.[]</strong><br>Required</td><td><strong>object</strong><br>Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with MemoryDB.</td></tr><tr><td><strong>subnets.[].availabilityZone.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].identifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/memorydb/v1alpha1/user/index.html b/reference/memorydb/v1alpha1/user/index.html index 6a57689f60..81ca5d3558 100644 --- a/reference/memorydb/v1alpha1/user/index.html +++ b/reference/memorydb/v1alpha1/user/index.html @@ -161,4 +161,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member that is used to contain resource sync state, account ownership, constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>aclNames</strong><br>Optional</td><td><strong>array</strong><br>The names of the Access Control Lists to which the user belongs</td></tr><tr><td><strong>aclNames.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>authentication.passwordCount</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td>**authentication.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that contains a collection of <code>ackv1alpha1.Condition</code> objects that describe the various terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource</td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>events</strong><br>Optional</td><td><strong>array</strong><br>A list of events. Each element in the list contains detailed information about one event.</td></tr><tr><td><strong>events.[]</strong><br>Required</td><td><strong>object</strong><br>Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster or adding or removing a node.</td></tr><tr><td><strong>events.[].message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>events.[].sourceType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>minimumEngineVersion</strong><br>Optional</td><td><strong>string</strong><br>The minimum engine version supported for the user</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>Indicates the user status. Can be “active”, “modifying” or “deleting”.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/mq/v1alpha1/broker/index.html b/reference/mq/v1alpha1/broker/index.html index 68abbc30c2..aaad1aa44e 100644 --- a/reference/mq/v1alpha1/broker/index.html +++ b/reference/mq/v1alpha1/broker/index.html @@ -225,4 +225,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>brokerID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>brokerInstances</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>brokerInstances.[]</strong><br>Required</td><td><strong>object</strong><br>Returns information about all brokers.</td></tr><tr><td><strong>brokerInstances.[].endpoints</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>brokerInstances.[].endpoints.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>brokerState</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/networkfirewall/v1alpha1/firewall/index.html b/reference/networkfirewall/v1alpha1/firewall/index.html index 87fd336246..4bf31bb536 100644 --- a/reference/networkfirewall/v1alpha1/firewall/index.html +++ b/reference/networkfirewall/v1alpha1/firewall/index.html @@ -187,4 +187,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>firewall</strong><br>Optional</td><td><strong>object</strong><br>The configuration settings for the firewall. These settings include the firewall<br>policy and the subnets in your VPC to use for the firewall endpoints.</td></tr><tr><td><strong>firewall.deleteProtection</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>firewall.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.encryptionConfiguration</strong><br>Optional</td><td><strong>object</strong><br>A complex type that contains optional Amazon Web Services Key Management<br>Service (KMS) encryption settings for your Network Firewall resources. Your<br>data is encrypted by default with an Amazon Web Services owned key that Amazon<br>Web Services owns and manages for you. You can use either the Amazon Web<br>Services owned key, or provide your own customer managed key. To learn more<br>about KMS encryption of your Network Firewall resources, see Encryption at<br>rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)<br>in the Network Firewall Developer Guide.</td></tr><tr><td><strong>firewall.encryptionConfiguration.keyID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**firewall.encryptionConfiguration.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.firewallARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.firewallID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.firewallName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.firewallPolicyARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.firewallPolicyChangeProtection</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>firewall.subnetChangeProtection</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>firewall.subnetMappings</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>firewall.subnetMappings.[]</strong><br>Required</td><td><strong>object</strong><br>The ID for a subnet that you want to associate with the firewall. This is</td></tr><tr><td>used with CreateFirewall and AssociateSubnets. Network Firewall creates an</td><td></td></tr><tr><td>instance of the associated firewall in each subnet that you specify, to filter</td><td></td></tr><tr><td>traffic in the subnet’s Availability Zone.</td><td></td></tr><tr><td><strong>firewall.subnetMappings.[].subnetID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.tags</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>firewall.tags.[]</strong><br>Required</td><td><strong>object</strong><br>A key:value pair associated with an Amazon Web Services resource. The key:value</td></tr><tr><td>pair can be anything you define. Typically, the tag key represents a category</td><td></td></tr><tr><td>(such as “environment”) and the tag value represents a specific value within</td><td></td></tr><tr><td>that category (such as “test,” “development,” or “production”). You can add</td><td></td></tr><tr><td>up to 50 tags to each Amazon Web Services resource.</td><td></td></tr><tr><td><strong>firewall.tags.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewall.vpcID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallStatus</strong><br>Optional</td><td><strong>object</strong><br>Detailed information about the current status of a Firewall. You can retrieve<br>this for a firewall by calling DescribeFirewall and providing the firewall<br>name and ARN.</td></tr><tr><td><strong>firewallStatus.capacityUsageSummary</strong><br>Optional</td><td><strong>object</strong><br>The capacity usage summary of the resources used by the ReferenceSets in<br>a firewall.</td></tr><tr><td><strong>firewallStatus.capacityUsageSummary.cidrs</strong><br>Optional</td><td><strong>object</strong><br>Summarizes the CIDR blocks used by the IP set references in a firewall. Network<br>Firewall calculates the number of CIDRs by taking an aggregated count of<br>all CIDRs used by the IP sets you are referencing.</td></tr><tr><td><strong>firewallStatus.capacityUsageSummary.cidrs.availableCIDRCount</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>firewallStatus.capacityUsageSummary.cidrs.iPSetReferences</strong><br>Optional</td><td><strong>object</strong><br></td></tr><tr><td><strong>firewallStatus.capacityUsageSummary.cidrs.utilizedCIDRCount</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>firewallStatus.configurationSyncStateSummary</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallStatus.status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallStatus.syncStates</strong><br>Optional</td><td><strong>object</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/networkfirewall/v1alpha1/firewallpolicy/index.html b/reference/networkfirewall/v1alpha1/firewallpolicy/index.html index 9eb68d6edb..dd107d1512 100644 --- a/reference/networkfirewall/v1alpha1/firewallpolicy/index.html +++ b/reference/networkfirewall/v1alpha1/firewallpolicy/index.html @@ -225,4 +225,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>firewallPolicyResponse</strong><br>Optional</td><td><strong>object</strong><br>The high-level properties of a firewall policy. This, along with the FirewallPolicy,<br>define the policy. You can retrieve all objects for a firewall policy by<br>calling DescribeFirewallPolicy.</td></tr><tr><td><strong>firewallPolicyResponse.consumedStatefulRuleCapacity</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.consumedStatelessRuleCapacity</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.encryptionConfiguration</strong><br>Optional</td><td><strong>object</strong><br>A complex type that contains optional Amazon Web Services Key Management<br>Service (KMS) encryption settings for your Network Firewall resources. Your<br>data is encrypted by default with an Amazon Web Services owned key that Amazon<br>Web Services owns and manages for you. You can use either the Amazon Web<br>Services owned key, or provide your own customer managed key. To learn more<br>about KMS encryption of your Network Firewall resources, see Encryption at<br>rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)<br>in the Network Firewall Developer Guide.</td></tr><tr><td><strong>firewallPolicyResponse.encryptionConfiguration.keyID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**firewallPolicyResponse.encryptionConfiguration.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.firewallPolicyARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.firewallPolicyID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.firewallPolicyName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.firewallPolicyStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.numberOfAssociations</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.tags</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>firewallPolicyResponse.tags.[]</strong><br>Required</td><td><strong>object</strong><br>A key:value pair associated with an Amazon Web Services resource. The key:value</td></tr><tr><td>pair can be anything you define. Typically, the tag key represents a category</td><td></td></tr><tr><td>(such as “environment”) and the tag value represents a specific value within</td><td></td></tr><tr><td>that category (such as “test,” “development,” or “production”). You can add</td><td></td></tr><tr><td>up to 50 tags to each Amazon Web Services resource.</td><td></td></tr><tr><td><strong>firewallPolicyResponse.tags.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>updateToken</strong><br>Optional</td><td><strong>string</strong><br>A token used for optimistic locking. Network Firewall returns a token to<br>your requests that access the firewall policy. The token marks the state<br>of the policy resource at the time of the request.<br><br><br>To make changes to the policy, you provide the token in your request. Network<br>Firewall uses the token to ensure that the policy hasn’t changed since you<br>last retrieved it. If it has changed, the operation fails with an InvalidTokenException.<br>If this happens, retrieve the firewall policy again to get a current copy<br>of it with current token. Reapply your changes as needed, then try the operation<br>again using the new token.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/networkfirewall/v1alpha1/rulegroup/index.html b/reference/networkfirewall/v1alpha1/rulegroup/index.html index 2ce0e1e80c..c6e27e766b 100644 --- a/reference/networkfirewall/v1alpha1/rulegroup/index.html +++ b/reference/networkfirewall/v1alpha1/rulegroup/index.html @@ -305,4 +305,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>ruleGroupResponse</strong><br>Optional</td><td><strong>object</strong><br>The high-level properties of a rule group. This, along with the RuleGroup,<br>define the rule group. You can retrieve all objects for a rule group by calling<br>DescribeRuleGroup.</td></tr><tr><td><strong>ruleGroupResponse.analysisResults</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>ruleGroupResponse.analysisResults.[]</strong><br>Required</td><td><strong>object</strong><br>The analysis result for Network Firewall’s stateless rule group analyzer.</td></tr><tr><td>Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup</td><td></td></tr><tr><td>on a stateless rule group, Network Firewall analyzes the stateless rule groups</td><td></td></tr><tr><td>in your account and identifies the rules that might adversely effect your</td><td></td></tr><tr><td>firewall’s functionality. For example, if Network Firewall detects a rule</td><td></td></tr><tr><td>that’s routing traffic asymmetrically, which impacts the service’s ability</td><td></td></tr><tr><td>to properly process traffic, the service includes the rule in a list of analysis</td><td></td></tr><tr><td>results.</td><td></td></tr><tr><td><strong>ruleGroupResponse.analysisResults.[].identifiedRuleIDs</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>ruleGroupResponse.analysisResults.[].identifiedRuleIDs.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.capacity</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>ruleGroupResponse.consumedCapacity</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>ruleGroupResponse.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.encryptionConfiguration</strong><br>Optional</td><td><strong>object</strong><br>A complex type that contains optional Amazon Web Services Key Management<br>Service (KMS) encryption settings for your Network Firewall resources. Your<br>data is encrypted by default with an Amazon Web Services owned key that Amazon<br>Web Services owns and manages for you. You can use either the Amazon Web<br>Services owned key, or provide your own customer managed key. To learn more<br>about KMS encryption of your Network Firewall resources, see Encryption at<br>rest with Amazon Web Services Key Managment Service (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)<br>in the Network Firewall Developer Guide.</td></tr><tr><td><strong>ruleGroupResponse.encryptionConfiguration.keyID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**ruleGroupResponse.encryptionConfiguration.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.numberOfAssociations</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>ruleGroupResponse.ruleGroupARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.ruleGroupID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.ruleGroupName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.ruleGroupStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.snsTopic</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.sourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>High-level information about the managed rule group that your own rule group<br>is copied from. You can use the the metadata to track version updates made<br>to the originating rule group. You can retrieve all objects for a rule group<br>by calling DescribeRuleGroup (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html).</td></tr><tr><td><strong>ruleGroupResponse.sourceMetadata.sourceARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.sourceMetadata.sourceUpdateToken</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>ruleGroupResponse.tags</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>ruleGroupResponse.tags.[]</strong><br>Required</td><td><strong>object</strong><br>A key:value pair associated with an Amazon Web Services resource. The key:value</td></tr><tr><td>pair can be anything you define. Typically, the tag key represents a category</td><td></td></tr><tr><td>(such as “environment”) and the tag value represents a specific value within</td><td></td></tr><tr><td>that category (such as “test,” “development,” or “production”). You can add</td><td></td></tr><tr><td>up to 50 tags to each Amazon Web Services resource.</td><td></td></tr><tr><td><strong>ruleGroupResponse.tags.[].value</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**ruleGroupResponse.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>updateToken</strong><br>Optional</td><td><strong>string</strong><br>A token used for optimistic locking. Network Firewall returns a token to<br>your requests that access the rule group. The token marks the state of the<br>rule group resource at the time of the request.<br><br><br>To make changes to the rule group, you provide the token in your request.<br>Network Firewall uses the token to ensure that the rule group hasn’t changed<br>since you last retrieved it. If it has changed, the operation fails with<br>an InvalidTokenException. If this happens, retrieve the rule group again<br>to get a current copy of it with a current token. Reapply your changes as<br>needed, then try the operation again using the new token.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/opensearchservice/v1alpha1/domain/index.html b/reference/opensearchservice/v1alpha1/domain/index.html index 6ee5a4b10c..71007699a9 100644 --- a/reference/opensearchservice/v1alpha1/domain/index.html +++ b/reference/opensearchservice/v1alpha1/domain/index.html @@ -237,4 +237,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>changeProgressDetails</strong><br>Optional</td><td><strong>object</strong><br>Specifies change details of the domain configuration change.</td></tr><tr><td><strong>changeProgressDetails.changeID</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>changeProgressDetails.message</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>created</strong><br>Optional</td><td><strong>boolean</strong><br>The domain creation status. True if the creation of a domain is complete.<br>False if domain creation is still in progress.</td></tr><tr><td><strong>deleted</strong><br>Optional</td><td><strong>boolean</strong><br>The domain deletion status. True if a delete request has been received for<br>the domain but resource cleanup is still in progress. False if the domain<br>has not been deleted. Once domain deletion is complete, the status of the<br>domain is no longer returned.</td></tr><tr><td><strong>domainID</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier for the specified domain.</td></tr><tr><td><strong>endpoint</strong><br>Optional</td><td><strong>string</strong><br>The domain endpoint that you use to submit index and search requests.</td></tr><tr><td><strong>endpoints</strong><br>Optional</td><td><strong>object</strong><br>Map containing the domain endpoints used to submit index and search requests.<br>Example key, value: ‘vpc’,‘vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com’.</td></tr><tr><td><strong>processing</strong><br>Optional</td><td><strong>boolean</strong><br>The status of the domain configuration. True if Amazon OpenSearch Service<br>is processing configuration changes. False if the configuration is active.</td></tr><tr><td><strong>serviceSoftwareOptions</strong><br>Optional</td><td><strong>object</strong><br>The current status of the domain’s service software.</td></tr><tr><td><strong>serviceSoftwareOptions.automatedUpdateDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.cancellable</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.currentVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.newVersion</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.optionalDeployment</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.updateAvailable</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>serviceSoftwareOptions.updateStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>snapshotOptions</strong><br>Optional</td><td><strong>object</strong><br>The status of the SnapshotOptions.</td></tr><tr><td><strong>snapshotOptions.automatedSnapshotStartHour</strong><br>Optional</td><td><strong>integer</strong><br></td></tr><tr><td><strong>upgradeProcessing</strong><br>Optional</td><td><strong>boolean</strong><br>The status of a domain version upgrade. True if Amazon OpenSearch Service<br>is undergoing a version upgrade. False if the configuration is active.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/organizations/v1alpha1/organizationalunit/index.html b/reference/organizations/v1alpha1/organizationalunit/index.html index c8bd408fe6..4724810c7c 100644 --- a/reference/organizations/v1alpha1/organizationalunit/index.html +++ b/reference/organizations/v1alpha1/organizationalunit/index.html @@ -148,4 +148,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier (ID) associated with this OU.<br><br><br>The regex pattern (http://wikipedia.org/wiki/regex) for an organizational<br>unit ID string requires “ou-” followed by from 4 to 32 lowercase letters<br>or digits (the ID of the root that contains the OU). This string is followed<br>by a second “-” dash and from 8 to 32 additional lowercase letters or digits.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/pipes/v1alpha1/pipe/index.html b/reference/pipes/v1alpha1/pipe/index.html index aff66ace5d..76a4a0a134 100644 --- a/reference/pipes/v1alpha1/pipe/index.html +++ b/reference/pipes/v1alpha1/pipe/index.html @@ -480,4 +480,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time the pipe was created.</td></tr><tr><td><strong>currentState</strong><br>Optional</td><td><strong>string</strong><br>The state the pipe is in.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>When the pipe was last updated, in ISO-8601 format (https://www.w3.org/TR/NOTE-datetime)<br>(YYYY-MM-DDThh:mm:ss.sTZD).</td></tr><tr><td><strong>stateReason</strong><br>Optional</td><td><strong>string</strong><br>The reason the pipe is in its current state.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/prometheusservice/v1alpha1/alertmanagerdefinition/index.html b/reference/prometheusservice/v1alpha1/alertmanagerdefinition/index.html index 368c08bb18..86d2bdeef3 100644 --- a/reference/prometheusservice/v1alpha1/alertmanagerdefinition/index.html +++ b/reference/prometheusservice/v1alpha1/alertmanagerdefinition/index.html @@ -145,4 +145,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>statusCode</strong><br>Optional</td><td><strong>string</strong><br>Status code of this definition.</td></tr><tr><td><strong>statusReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for failure if any.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/prometheusservice/v1alpha1/loggingconfiguration/index.html b/reference/prometheusservice/v1alpha1/loggingconfiguration/index.html index 4a642a222c..8072a34955 100644 --- a/reference/prometheusservice/v1alpha1/loggingconfiguration/index.html +++ b/reference/prometheusservice/v1alpha1/loggingconfiguration/index.html @@ -145,4 +145,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>statusCode</strong><br>Optional</td><td><strong>string</strong><br>Status code of the logging configuration.</td></tr><tr><td><strong>statusReason</strong><br>Optional</td><td><strong>string</strong><br>The reason for failure if any.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/prometheusservice/v1alpha1/rulegroupsnamespace/index.html b/reference/prometheusservice/v1alpha1/rulegroupsnamespace/index.html index b0a2e7c85c..0e7206fc78 100644 --- a/reference/prometheusservice/v1alpha1/rulegroupsnamespace/index.html +++ b/reference/prometheusservice/v1alpha1/rulegroupsnamespace/index.html @@ -148,4 +148,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>object</strong><br>The status of rule groups namespace.</td></tr><tr><td><strong>status.statusCode</strong><br>Optional</td><td><strong>string</strong><br>State of a namespace.</td></tr><tr><td><strong>status.statusReason</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/prometheusservice/v1alpha1/workspace/index.html b/reference/prometheusservice/v1alpha1/workspace/index.html index 512f9e4c1c..b892436cbd 100644 --- a/reference/prometheusservice/v1alpha1/workspace/index.html +++ b/reference/prometheusservice/v1alpha1/workspace/index.html @@ -143,4 +143,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>object</strong><br>The status of the workspace that was just created (usually CREATING).</td></tr><tr><td><strong>status.statusCode</strong><br>Optional</td><td><strong>string</strong><br>State of a workspace.</td></tr><tr><td><strong>workspaceID</strong><br>Optional</td><td><strong>string</strong><br>The generated ID of the workspace that was just created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbcluster/index.html b/reference/rds/v1alpha1/dbcluster/index.html index 0bda42e83f..471293f2c7 100644 --- a/reference/rds/v1alpha1/dbcluster/index.html +++ b/reference/rds/v1alpha1/dbcluster/index.html @@ -320,4 +320,4 @@ | <strong>vpcSecurityGroups.[].vpcSecurityGroupID</strong><br>Optional | <strong>string</strong><br>|</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbclusterparametergroup/index.html b/reference/rds/v1alpha1/dbclusterparametergroup/index.html index 0f733d7cd7..4b750da981 100644 --- a/reference/rds/v1alpha1/dbclusterparametergroup/index.html +++ b/reference/rds/v1alpha1/dbclusterparametergroup/index.html @@ -200,4 +200,4 @@ | <strong>parameterOverrideStatuses.[].supportedEngineModes.[]</strong><br>Required | <strong>string</strong><br>|</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbinstance/index.html b/reference/rds/v1alpha1/dbinstance/index.html index 157849c314..bd19ad95ee 100644 --- a/reference/rds/v1alpha1/dbinstance/index.html +++ b/reference/rds/v1alpha1/dbinstance/index.html @@ -465,4 +465,4 @@ | <strong>vpcSecurityGroups.[].vpcSecurityGroupID</strong><br>Optional | <strong>string</strong><br>|</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbparametergroup/index.html b/reference/rds/v1alpha1/dbparametergroup/index.html index bc4b088d8e..80c55c754b 100644 --- a/reference/rds/v1alpha1/dbparametergroup/index.html +++ b/reference/rds/v1alpha1/dbparametergroup/index.html @@ -175,4 +175,4 @@ | <strong>parameterOverrideStatuses.[].supportedEngineModes.[]</strong><br>Required | <strong>string</strong><br>|</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbproxy/index.html b/reference/rds/v1alpha1/dbproxy/index.html index 24b1896bb6..8a487883a9 100644 --- a/reference/rds/v1alpha1/dbproxy/index.html +++ b/reference/rds/v1alpha1/dbproxy/index.html @@ -169,4 +169,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>createdDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the proxy was first created.</td></tr><tr><td><strong>endpoint</strong><br>Optional</td><td><strong>string</strong><br>The endpoint that you can use to connect to the DB proxy. You include the<br>endpoint value in the connection string for a database client application.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current status of this proxy. A status of available means the proxy is<br>ready to handle requests. Other values indicate that you must wait for the<br>proxy to be ready, or take some action to resolve an issue.</td></tr><tr><td><strong>updatedDate</strong><br>Optional</td><td><strong>string</strong><br>The date and time when the proxy was last updated.</td></tr><tr><td><strong>vpcID</strong><br>Optional</td><td><strong>string</strong><br>Provides the VPC ID of the DB proxy.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/dbsubnetgroup/index.html b/reference/rds/v1alpha1/dbsubnetgroup/index.html index fdd5a22ff1..8ebdbd0f9c 100644 --- a/reference/rds/v1alpha1/dbsubnetgroup/index.html +++ b/reference/rds/v1alpha1/dbsubnetgroup/index.html @@ -168,4 +168,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>subnetGroupStatus</strong><br>Optional</td><td><strong>string</strong><br>Provides the status of the DB subnet group.</td></tr><tr><td><strong>subnets</strong><br>Optional</td><td><strong>array</strong><br>Contains a list of Subnet elements.</td></tr><tr><td><strong>subnets.[]</strong><br>Required</td><td><strong>object</strong><br>This data type is used as a response element for the DescribeDBSubnetGroups</td></tr><tr><td>operation.</td><td></td></tr><tr><td><strong>subnets.[].subnetAvailabilityZone.name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetIdentifier</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetOutpost</strong><br>Optional</td><td><strong>object</strong><br>A data type that represents an Outpost.<br><br><br>For more information about RDS on Outposts, see Amazon RDS on Amazon Web<br>Services Outposts (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html)<br>in the Amazon RDS User Guide.</td></tr><tr><td><strong>subnets.[].subnetOutpost.arn</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>subnets.[].subnetStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>supportedNetworkTypes</strong><br>Optional</td><td><strong>array</strong><br>The network type of the DB subnet group.<br><br><br>Valid values:<br><br><br>* IPV4<br><br><br>* DUAL<br><br><br>A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6<br>protocols (DUAL).<br><br><br>For more information, see Working with a DB instance in a VPC (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html)<br>in the Amazon RDS User Guide.</td></tr><tr><td><strong>supportedNetworkTypes.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/rds/v1alpha1/globalcluster/index.html b/reference/rds/v1alpha1/globalcluster/index.html index e8b30b7af2..72d3b042c7 100644 --- a/reference/rds/v1alpha1/globalcluster/index.html +++ b/reference/rds/v1alpha1/globalcluster/index.html @@ -158,4 +158,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failoverState</strong><br>Optional</td><td><strong>object</strong><br>A data object containing all properties for the current state of an in-process<br>or pending failover process for this Aurora global database. This object<br>is empty unless the FailoverGlobalCluster API operation has been called on<br>this Aurora global database (GlobalCluster).</td></tr><tr><td><strong>failoverState.fromDBClusterARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>failoverState.status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>failoverState.toDBClusterARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>globalClusterMembers</strong><br>Optional</td><td><strong>array</strong><br>The list of primary and secondary clusters within the global database cluster.</td></tr><tr><td><strong>globalClusterMembers.[]</strong><br>Required</td><td><strong>object</strong><br>A data structure with information about any primary and secondary clusters</td></tr><tr><td>associated with an Aurora global database.</td><td></td></tr><tr><td><strong>globalClusterMembers.[].globalWriteForwardingStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>globalClusterMembers.[].isWriter</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>globalClusterMembers.[].readers</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>globalClusterMembers.[].readers.[]</strong><br>Required</td><td><strong>string</strong><br></td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>Specifies the current state of this global database cluster.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/route53/v1alpha1/hostedzone/index.html b/reference/route53/v1alpha1/hostedzone/index.html index 8b8dbfe959..f269a08b90 100644 --- a/reference/route53/v1alpha1/hostedzone/index.html +++ b/reference/route53/v1alpha1/hostedzone/index.html @@ -159,4 +159,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>callerReference</strong><br>Optional</td><td><strong>string</strong><br>The value that you specified for CallerReference when you created the hosted<br>zone.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>config</strong><br>Optional</td><td><strong>object</strong><br>A complex type that includes the Comment and PrivateZone elements. If you<br>omitted the HostedZoneConfig and Comment elements from the request, the Config<br>and Comment elements don’t appear in the response.</td></tr><tr><td><strong>config.comment</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>config.privateZone</strong><br>Optional</td><td><strong>boolean</strong><br></td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ID that Amazon Route 53 assigned to the hosted zone when you created<br>it.</td></tr><tr><td><strong>linkedService</strong><br>Optional</td><td><strong>object</strong><br>If the hosted zone was created by another service, the service that created<br>the hosted zone. When a hosted zone is created by another service, you can’t<br>edit or delete it using Route 53.</td></tr><tr><td><strong>linkedService.description</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>linkedService.servicePrincipal</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>resourceRecordSetCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of resource record sets in the hosted zone.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/route53/v1alpha1/recordset/index.html b/reference/route53/v1alpha1/recordset/index.html index f8d7cdc782..baa4860532 100644 --- a/reference/route53/v1alpha1/recordset/index.html +++ b/reference/route53/v1alpha1/recordset/index.html @@ -223,4 +223,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>This element contains an ID that you use when performing a GetChange (https://docs.aws.amazon.com/Route53/latest/APIReference/API_GetChange.html)<br>action to get detailed information about the change.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The current state of the request. PENDING indicates that this request has<br>not yet been applied to all Amazon Route 53 DNS servers.</td></tr><tr><td><strong>submittedAt</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the change request was submitted in ISO 8601 format<br>(https://en.wikipedia.org/wiki/ISO_8601) and Coordinated Universal Time (UTC).<br>For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017<br>at 17:48:16.751 UTC.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/route53resolver/v1alpha1/resolverendpoint/index.html b/reference/route53resolver/v1alpha1/resolverendpoint/index.html index eecac02cb6..1788a05a25 100644 --- a/reference/route53resolver/v1alpha1/resolverendpoint/index.html +++ b/reference/route53resolver/v1alpha1/resolverendpoint/index.html @@ -176,4 +176,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the endpoint was created, in Unix time format and<br>Coordinated Universal Time (UTC).</td></tr><tr><td><strong>creatorRequestID</strong><br>Optional</td><td><strong>string</strong><br>A unique string that identifies the request that created the Resolver endpoint.<br>The CreatorRequestId allows failed requests to be retried without the risk<br>of running the operation twice.</td></tr><tr><td><strong>hostVPCID</strong><br>Optional</td><td><strong>string</strong><br>The ID of the VPC that you want to create the Resolver endpoint in.</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ID of the Resolver endpoint.</td></tr><tr><td><strong>ipAddressCount</strong><br>Optional</td><td><strong>integer</strong><br>The number of IP addresses that the Resolver endpoint can use for DNS queries.</td></tr><tr><td><strong>modificationTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the endpoint was last modified, in Unix time format<br>and Coordinated Universal Time (UTC).</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>A code that specifies the current status of the Resolver endpoint. Valid<br>values include the following:<br><br><br>* CREATING: Resolver is creating and configuring one or more Amazon VPC<br>network interfaces for this endpoint.<br><br><br>* OPERATIONAL: The Amazon VPC network interfaces for this endpoint are<br>correctly configured and able to pass inbound or outbound DNS queries<br>between your network and Resolver.<br><br><br>* UPDATING: Resolver is associating or disassociating one or more network<br>interfaces with this endpoint.<br><br><br>* AUTO_RECOVERING: Resolver is trying to recover one or more of the network<br>interfaces that are associated with this endpoint. During the recovery<br>process, the endpoint functions with limited capacity because of the limit<br>on the number of DNS queries per IP address (per network interface). For<br>the current limit, see Limits on Route 53 Resolver (https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver).<br><br><br>* ACTION_NEEDED: This endpoint is unhealthy, and Resolver can’t automatically<br>recover it. To resolve the problem, we recommend that you check each IP<br>address that you associated with the endpoint. For each IP address that<br>isn’t available, add another IP address and then delete the IP address<br>that isn’t available. (An endpoint must always include at least two IP<br>addresses.) A status of ACTION_NEEDED can have a variety of causes. Here<br>are two common causes: One or more of the network interfaces that are<br>associated with the endpoint were deleted using Amazon VPC. The network<br>interface couldn’t be created for some reason that’s outside the control<br>of Resolver.<br><br><br>* DELETING: Resolver is deleting this endpoint and the associated network<br>interfaces.</td></tr><tr><td><strong>statusMessage</strong><br>Optional</td><td><strong>string</strong><br>A detailed description of the status of the Resolver endpoint.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/route53resolver/v1alpha1/resolverrule/index.html b/reference/route53resolver/v1alpha1/resolverrule/index.html index ca74d50445..0e6563c09c 100644 --- a/reference/route53resolver/v1alpha1/resolverrule/index.html +++ b/reference/route53resolver/v1alpha1/resolverrule/index.html @@ -171,4 +171,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the Resolver rule was created, in Unix time format<br>and Coordinated Universal Time (UTC).</td></tr><tr><td><strong>creatorRequestID</strong><br>Optional</td><td><strong>string</strong><br>A unique string that you specified when you created the Resolver rule. CreatorRequestId<br>identifies the request and allows failed requests to be retried without the<br>risk of running the operation twice.</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ID that Resolver assigned to the Resolver rule when you created it.</td></tr><tr><td><strong>modificationTime</strong><br>Optional</td><td><strong>string</strong><br>The date and time that the Resolver rule was last updated, in Unix time format<br>and Coordinated Universal Time (UTC).</td></tr><tr><td><strong>ownerID</strong><br>Optional</td><td><strong>string</strong><br>When a rule is shared with another Amazon Web Services account, the account<br>ID of the account that the rule is shared with.</td></tr><tr><td><strong>shareStatus</strong><br>Optional</td><td><strong>string</strong><br>Whether the rule is shared and, if so, whether the current account is sharing<br>the rule with another account, or another account is sharing the rule with<br>the current account.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>A code that specifies the current status of the Resolver rule.</td></tr><tr><td><strong>statusMessage</strong><br>Optional</td><td><strong>string</strong><br>A detailed description of the status of a Resolver rule.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/s3/v1alpha1/bucket/index.html b/reference/s3/v1alpha1/bucket/index.html index 825566eb5c..613f13a10e 100644 --- a/reference/s3/v1alpha1/bucket/index.html +++ b/reference/s3/v1alpha1/bucket/index.html @@ -632,4 +632,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>location</strong><br>Optional</td><td><strong>string</strong><br>A forward slash followed by the name of the bucket.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/app/index.html b/reference/sagemaker/v1alpha1/app/index.html index 7bb00ac8e7..6be133fded 100644 --- a/reference/sagemaker/v1alpha1/app/index.html +++ b/reference/sagemaker/v1alpha1/app/index.html @@ -161,4 +161,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/dataqualityjobdefinition/index.html b/reference/sagemaker/v1alpha1/dataqualityjobdefinition/index.html index 2b9991d7d2..ae302a6b77 100644 --- a/reference/sagemaker/v1alpha1/dataqualityjobdefinition/index.html +++ b/reference/sagemaker/v1alpha1/dataqualityjobdefinition/index.html @@ -202,4 +202,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/domain/index.html b/reference/sagemaker/v1alpha1/domain/index.html index 4283aa3216..3fdd79b4c6 100644 --- a/reference/sagemaker/v1alpha1/domain/index.html +++ b/reference/sagemaker/v1alpha1/domain/index.html @@ -254,4 +254,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>domainID</strong><br>Optional</td><td><strong>string</strong><br>The domain ID.</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status.</td></tr><tr><td><strong>url</strong><br>Optional</td><td><strong>string</strong><br>The URL to the created domain.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/endpoint/index.html b/reference/sagemaker/v1alpha1/endpoint/index.html index 1379e15f8d..88c7c666e6 100644 --- a/reference/sagemaker/v1alpha1/endpoint/index.html +++ b/reference/sagemaker/v1alpha1/endpoint/index.html @@ -305,4 +305,4 @@ | <strong>productionVariants.[].variantStatus.[].statusMessage</strong><br>Optional | <strong>string</strong><br>|</p><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/endpointconfig/index.html b/reference/sagemaker/v1alpha1/endpointconfig/index.html index 2b99abd1f5..2c4d7090a8 100644 --- a/reference/sagemaker/v1alpha1/endpointconfig/index.html +++ b/reference/sagemaker/v1alpha1/endpointconfig/index.html @@ -210,4 +210,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/featuregroup/index.html b/reference/sagemaker/v1alpha1/featuregroup/index.html index 428f12ada6..3873e554ac 100644 --- a/reference/sagemaker/v1alpha1/featuregroup/index.html +++ b/reference/sagemaker/v1alpha1/featuregroup/index.html @@ -192,4 +192,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>The reason that the FeatureGroup failed to be replicated in the OfflineStore.<br>This is failure can occur because:<br><br><br>* The FeatureGroup could not be created in the OfflineStore.<br><br><br>* The FeatureGroup could not be deleted from the OfflineStore.</td></tr><tr><td><strong>featureGroupStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the feature group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/hyperparametertuningjob/index.html b/reference/sagemaker/v1alpha1/hyperparametertuningjob/index.html index 0edce6300c..cda79001fc 100644 --- a/reference/sagemaker/v1alpha1/hyperparametertuningjob/index.html +++ b/reference/sagemaker/v1alpha1/hyperparametertuningjob/index.html @@ -578,4 +578,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>bestTrainingJob</strong><br>Optional</td><td><strong>object</strong><br>A TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)<br>object that describes the training job that completed with the best current<br>HyperParameterTuningJobObjective (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobObjective.html).</td></tr><tr><td><strong>bestTrainingJob.creationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.failureReason</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric</strong><br>Optional</td><td><strong>object</strong><br>Shows the latest objective metric emitted by a training job that was launched<br>by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective<br>parameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).</td></tr><tr><td><strong>bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value</strong><br>Optional</td><td><strong>number</strong><br></td></tr><tr><td><strong>bestTrainingJob.objectiveStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingEndTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingJobDefinitionName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingJobName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingJobStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.trainingStartTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>bestTrainingJob.tunedHyperParameters</strong><br>Optional</td><td><strong>object</strong><br></td></tr><tr><td><strong>bestTrainingJob.tuningJobName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>If the tuning job failed, the reason it failed.</td></tr><tr><td><strong>hyperParameterTuningJobStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the tuning job.</td></tr><tr><td><strong>overallBestTrainingJob</strong><br>Optional</td><td><strong>object</strong><br>If the hyperparameter tuning job is an warm start tuning job with a WarmStartType<br>of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_TrainingJobSummary.html)<br>for the training job with the best objective metric value of all training<br>jobs launched by this tuning job and all parent jobs specified for the warm<br>start tuning job.</td></tr><tr><td><strong>overallBestTrainingJob.creationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.failureReason</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric</strong><br>Optional</td><td><strong>object</strong><br>Shows the latest objective metric emitted by a training job that was launched<br>by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective<br>parameter of HyperParameterTuningJobConfig (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_HyperParameterTuningJobConfig.html).</td></tr><tr><td><strong>overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.metricName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td>**overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.type_**<br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.finalHyperParameterTuningJobObjectiveMetric.value</strong><br>Optional</td><td><strong>number</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.objectiveStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingEndTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingJobDefinitionName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingJobName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingJobStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.trainingStartTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.tunedHyperParameters</strong><br>Optional</td><td><strong>object</strong><br></td></tr><tr><td><strong>overallBestTrainingJob.tuningJobName</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/model/index.html b/reference/sagemaker/v1alpha1/model/index.html index 221ef3d245..7a50480259 100644 --- a/reference/sagemaker/v1alpha1/model/index.html +++ b/reference/sagemaker/v1alpha1/model/index.html @@ -207,4 +207,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/modelbiasjobdefinition/index.html b/reference/sagemaker/v1alpha1/modelbiasjobdefinition/index.html index 3fc2ac6367..347bccb612 100644 --- a/reference/sagemaker/v1alpha1/modelbiasjobdefinition/index.html +++ b/reference/sagemaker/v1alpha1/modelbiasjobdefinition/index.html @@ -197,4 +197,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/index.html b/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/index.html index 99444df21d..ebb34c5022 100644 --- a/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/index.html +++ b/reference/sagemaker/v1alpha1/modelexplainabilityjobdefinition/index.html @@ -195,4 +195,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/modelpackage/index.html b/reference/sagemaker/v1alpha1/modelpackage/index.html index 3d30396c5b..3f426dad7e 100644 --- a/reference/sagemaker/v1alpha1/modelpackage/index.html +++ b/reference/sagemaker/v1alpha1/modelpackage/index.html @@ -368,4 +368,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>A timestamp specifying when the model package was created.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The last time that the model package was modified.</td></tr><tr><td><strong>modelPackageStatus</strong><br>Optional</td><td><strong>string</strong><br>The current status of the model package.</td></tr><tr><td><strong>modelPackageStatusDetails</strong><br>Optional</td><td><strong>object</strong><br>Details about the current status of the model package.</td></tr><tr><td><strong>modelPackageStatusDetails.imageScanStatuses</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>modelPackageStatusDetails.imageScanStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>Represents the overall status of a model package.</td></tr><tr><td><strong>modelPackageStatusDetails.imageScanStatuses.[].name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>modelPackageStatusDetails.imageScanStatuses.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>modelPackageStatusDetails.validationStatuses</strong><br>Optional</td><td><strong>array</strong><br></td></tr><tr><td><strong>modelPackageStatusDetails.validationStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>Represents the overall status of a model package.</td></tr><tr><td><strong>modelPackageStatusDetails.validationStatuses.[].name</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>modelPackageStatusDetails.validationStatuses.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/modelpackagegroup/index.html b/reference/sagemaker/v1alpha1/modelpackagegroup/index.html index 9865b876ac..a3dc6293f6 100644 --- a/reference/sagemaker/v1alpha1/modelpackagegroup/index.html +++ b/reference/sagemaker/v1alpha1/modelpackagegroup/index.html @@ -153,4 +153,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>modelPackageGroupStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the model group.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/modelqualityjobdefinition/index.html b/reference/sagemaker/v1alpha1/modelqualityjobdefinition/index.html index 405795039d..14e4235bfa 100644 --- a/reference/sagemaker/v1alpha1/modelqualityjobdefinition/index.html +++ b/reference/sagemaker/v1alpha1/modelqualityjobdefinition/index.html @@ -203,4 +203,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/monitoringschedule/index.html b/reference/sagemaker/v1alpha1/monitoringschedule/index.html index 53670ed988..be092d85b1 100644 --- a/reference/sagemaker/v1alpha1/monitoringschedule/index.html +++ b/reference/sagemaker/v1alpha1/monitoringschedule/index.html @@ -227,4 +227,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time at which the monitoring job was created.</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>A string, up to one KB in size, that contains the reason a monitoring job<br>failed, if it failed.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The time at which the monitoring job was last modified.</td></tr><tr><td><strong>lastMonitoringExecutionSummary</strong><br>Optional</td><td><strong>object</strong><br>Describes metadata on the last execution to run, if there was one.</td></tr><tr><td><strong>lastMonitoringExecutionSummary.creationTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.endpointName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.failureReason</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.monitoringExecutionStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.monitoringJobDefinitionName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.monitoringScheduleName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.monitoringType</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.processingJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>lastMonitoringExecutionSummary.scheduledTime</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>monitoringScheduleStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of an monitoring job.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/notebookinstance/index.html b/reference/sagemaker/v1alpha1/notebookinstance/index.html index 5d11bef678..cf96a5929e 100644 --- a/reference/sagemaker/v1alpha1/notebookinstance/index.html +++ b/reference/sagemaker/v1alpha1/notebookinstance/index.html @@ -171,4 +171,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>If status is Failed, the reason it failed.</td></tr><tr><td><strong>notebookInstanceStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the notebook instance.</td></tr><tr><td><strong>stoppedByControllerMetadata</strong><br>Optional</td><td><strong>string</strong><br>The URL that you use to connect to the Jupyter notebook that is running in<br>your notebook instance.</td></tr><tr><td><strong>url</strong><br>Optional</td><td><strong>string</strong><br>The URL that you use to connect to the Jupyter notebook that is running in<br>your notebook instance.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/index.html b/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/index.html index 5ab33b44ce..1ef6bad630 100644 --- a/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/index.html +++ b/reference/sagemaker/v1alpha1/notebookinstancelifecycleconfig/index.html @@ -157,4 +157,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>A timestamp that tells when the lifecycle configuration was created.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>A timestamp that tells when the lifecycle configuration was last modified.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/pipeline/index.html b/reference/sagemaker/v1alpha1/pipeline/index.html index 108da887bd..889a96b247 100644 --- a/reference/sagemaker/v1alpha1/pipeline/index.html +++ b/reference/sagemaker/v1alpha1/pipeline/index.html @@ -160,4 +160,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time when the pipeline was created.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The time when the pipeline was last modified.</td></tr><tr><td><strong>pipelineStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the pipeline execution.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/pipelineexecution/index.html b/reference/sagemaker/v1alpha1/pipelineexecution/index.html index b8d0066cc1..31d2ac552c 100644 --- a/reference/sagemaker/v1alpha1/pipelineexecution/index.html +++ b/reference/sagemaker/v1alpha1/pipelineexecution/index.html @@ -155,4 +155,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>The time when the pipeline execution was created.</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>If the execution failed, a message describing why.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>The time when the pipeline execution was modified last.</td></tr><tr><td><strong>pipelineExecutionStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the pipeline execution.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/processingjob/index.html b/reference/sagemaker/v1alpha1/processingjob/index.html index 82d22f36b1..ae5a08c4f6 100644 --- a/reference/sagemaker/v1alpha1/processingjob/index.html +++ b/reference/sagemaker/v1alpha1/processingjob/index.html @@ -225,4 +225,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>A string, up to one KB in size, that contains the reason a processing job<br>failed, if it failed.</td></tr><tr><td><strong>processingJobStatus</strong><br>Optional</td><td><strong>string</strong><br>Provides the status of a processing job.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/trainingjob/index.html b/reference/sagemaker/v1alpha1/trainingjob/index.html index d83c84ae66..f2b9dd61f9 100644 --- a/reference/sagemaker/v1alpha1/trainingjob/index.html +++ b/reference/sagemaker/v1alpha1/trainingjob/index.html @@ -285,4 +285,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationTime</strong><br>Optional</td><td><strong>string</strong><br>A timestamp that indicates when the training job was created.</td></tr><tr><td><strong>debugRuleEvaluationStatuses</strong><br>Optional</td><td><strong>array</strong><br>Evaluation status of Amazon SageMaker Debugger rules for debugging on a training<br>job.</td></tr><tr><td><strong>debugRuleEvaluationStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>Information about the status of the rule evaluation.</td></tr><tr><td><strong>debugRuleEvaluationStatuses.[].ruleConfigurationName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>debugRuleEvaluationStatuses.[].ruleEvaluationJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>debugRuleEvaluationStatuses.[].ruleEvaluationStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>debugRuleEvaluationStatuses.[].statusDetails</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>If the training job failed, the reason it failed.</td></tr><tr><td><strong>lastModifiedTime</strong><br>Optional</td><td><strong>string</strong><br>A timestamp that indicates when the status of the training job was last modified.</td></tr><tr><td><strong>modelArtifacts</strong><br>Optional</td><td><strong>object</strong><br>Information about the Amazon S3 location that is configured for storing model<br>artifacts.</td></tr><tr><td><strong>modelArtifacts.s3ModelArtifacts</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>profilerRuleEvaluationStatuses</strong><br>Optional</td><td><strong>array</strong><br>Evaluation status of Amazon SageMaker Debugger rules for profiling on a training<br>job.</td></tr><tr><td><strong>profilerRuleEvaluationStatuses.[]</strong><br>Required</td><td><strong>object</strong><br>Information about the status of the rule evaluation.</td></tr><tr><td><strong>profilerRuleEvaluationStatuses.[].ruleConfigurationName</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>profilerRuleEvaluationStatuses.[].ruleEvaluationJobARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>profilerRuleEvaluationStatuses.[].ruleEvaluationStatus</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>profilerRuleEvaluationStatuses.[].statusDetails</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>profilingStatus</strong><br>Optional</td><td><strong>string</strong><br>Profiling status of a training job.</td></tr><tr><td><strong>secondaryStatus</strong><br>Optional</td><td><strong>string</strong><br>Provides detailed information about the state of the training job. For detailed<br>information on the secondary status of the training job, see StatusMessage<br>under SecondaryStatusTransition (https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_SecondaryStatusTransition.html).<br><br><br>SageMaker provides primary statuses and secondary statuses that apply to<br>each of them:<br><br><br>InProgress<br><br><br>* Starting - Starting the training job.<br><br><br>* Downloading - An optional stage for algorithms that support File training<br>input mode. It indicates that data is being downloaded to the ML storage<br>volumes.<br><br><br>* Training - Training is in progress.<br><br><br>* Interrupted - The job stopped because the managed spot training instances<br>were interrupted.<br><br><br>* Uploading - Training is complete and the model artifacts are being uploaded<br>to the S3 location.<br><br><br>Completed<br><br><br>* Completed - The training job has completed.<br><br><br>Failed<br><br><br>* Failed - The training job has failed. The reason for the failure is<br>returned in the FailureReason field of DescribeTrainingJobResponse.<br><br><br>Stopped<br><br><br>* MaxRuntimeExceeded - The job stopped because it exceeded the maximum<br>allowed runtime.<br><br><br>* MaxWaitTimeExceeded - The job stopped because it exceeded the maximum<br>allowed wait time.<br><br><br>* Stopped - The training job has stopped.<br><br><br>Stopping<br><br><br>* Stopping - Stopping the training job.<br><br><br>Valid values for SecondaryStatus are subject to change.<br><br><br>We no longer support the following secondary statuses:<br><br><br>* LaunchingMLInstances<br><br><br>* PreparingTraining<br><br><br>* DownloadingTrainingImage</td></tr><tr><td><strong>trainingJobStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the training job.<br><br><br>SageMaker provides the following training job statuses:<br><br><br>* InProgress - The training is in progress.<br><br><br>* Completed - The training job has completed.<br><br><br>* Failed - The training job has failed. To see the reason for the failure,<br>see the FailureReason field in the response to a DescribeTrainingJobResponse<br>call.<br><br><br>* Stopping - The training job is stopping.<br><br><br>* Stopped - The training job has stopped.<br><br><br>For more detailed information, see SecondaryStatus.</td></tr><tr><td><strong>warmPoolStatus</strong><br>Optional</td><td><strong>object</strong><br>The status of the warm pool associated with the training job.</td></tr><tr><td><strong>warmPoolStatus.resourceRetainedBillableTimeInSeconds</strong><br>Optional</td><td><strong>integer</strong><br>Optional. Indicates how many seconds the resource stayed in ResourceRetained<br>state. Populated only after resource reaches ResourceReused or ResourceReleased<br>state.</td></tr><tr><td><strong>warmPoolStatus.reusedByJob</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>warmPoolStatus.status</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/transformjob/index.html b/reference/sagemaker/v1alpha1/transformjob/index.html index b40517f786..ed4f3aab80 100644 --- a/reference/sagemaker/v1alpha1/transformjob/index.html +++ b/reference/sagemaker/v1alpha1/transformjob/index.html @@ -205,4 +205,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>failureReason</strong><br>Optional</td><td><strong>string</strong><br>If the transform job failed, FailureReason describes why it failed. A transform<br>job creates a log file, which includes error messages, and stores it as an<br>Amazon S3 object. For more information, see Log Amazon SageMaker Events with<br>Amazon CloudWatch (https://docs.aws.amazon.com/sagemaker/latest/dg/logging-cloudwatch.html).</td></tr><tr><td><strong>transformJobStatus</strong><br>Optional</td><td><strong>string</strong><br>The status of the transform job. If the transform job failed, the reason<br>is returned in the FailureReason field.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sagemaker/v1alpha1/userprofile/index.html b/reference/sagemaker/v1alpha1/userprofile/index.html index ece4c0539c..e5b38c0ee6 100644 --- a/reference/sagemaker/v1alpha1/userprofile/index.html +++ b/reference/sagemaker/v1alpha1/userprofile/index.html @@ -304,4 +304,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>status</strong><br>Optional</td><td><strong>string</strong><br>The status.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/secretsmanager/v1alpha1/secret/index.html b/reference/secretsmanager/v1alpha1/secret/index.html index 2c8ee2bb68..331c2ba497 100644 --- a/reference/secretsmanager/v1alpha1/secret/index.html +++ b/reference/secretsmanager/v1alpha1/secret/index.html @@ -160,4 +160,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>id</strong><br>Optional</td><td><strong>string</strong><br>The ARN of the secret.</td></tr><tr><td><strong>replicationStatus</strong><br>Optional</td><td><strong>array</strong><br>A list of the replicas of this secret and their status:<br><br><br>* Failed, which indicates that the replica was not created.<br><br><br>* InProgress, which indicates that Secrets Manager is in the process of<br>creating the replica.<br><br><br>* InSync, which indicates that the replica was created.</td></tr><tr><td><strong>replicationStatus.[]</strong><br>Required</td><td><strong>object</strong><br>A replication object consisting of a RegionReplicationStatus object and includes</td></tr><tr><td>a Region, KMSKeyId, status, and status message.</td><td></td></tr><tr><td><strong>replicationStatus.[].lastAccessedDate</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>replicationStatus.[].region</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>replicationStatus.[].status</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>replicationStatus.[].statusMessage</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>versionID</strong><br>Optional</td><td><strong>string</strong><br>The unique identifier associated with the version of the new secret.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sfn/v1alpha1/activity/index.html b/reference/sfn/v1alpha1/activity/index.html index c50e8b325e..094409df82 100644 --- a/reference/sfn/v1alpha1/activity/index.html +++ b/reference/sfn/v1alpha1/activity/index.html @@ -148,4 +148,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationDate</strong><br>Optional</td><td><strong>string</strong><br>The date the activity is created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sfn/v1alpha1/statemachine/index.html b/reference/sfn/v1alpha1/statemachine/index.html index f7de274e8a..a550f58ee0 100644 --- a/reference/sfn/v1alpha1/statemachine/index.html +++ b/reference/sfn/v1alpha1/statemachine/index.html @@ -162,4 +162,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>creationDate</strong><br>Optional</td><td><strong>string</strong><br>The date the state machine is created.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sns/v1alpha1/platformapplication/index.html b/reference/sns/v1alpha1/platformapplication/index.html index 006cb641d9..2a5b58f7ad 100644 --- a/reference/sns/v1alpha1/platformapplication/index.html +++ b/reference/sns/v1alpha1/platformapplication/index.html @@ -165,4 +165,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sns/v1alpha1/platformendpoint/index.html b/reference/sns/v1alpha1/platformendpoint/index.html index d702c52de1..04d31dd77f 100644 --- a/reference/sns/v1alpha1/platformendpoint/index.html +++ b/reference/sns/v1alpha1/platformendpoint/index.html @@ -143,4 +143,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>endpointARN</strong><br>Optional</td><td><strong>string</strong><br>EndpointArn returned from CreateEndpoint action.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sns/v1alpha1/subscription/index.html b/reference/sns/v1alpha1/subscription/index.html index 6796512ec4..2dd1f9d296 100644 --- a/reference/sns/v1alpha1/subscription/index.html +++ b/reference/sns/v1alpha1/subscription/index.html @@ -155,4 +155,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>confirmationWasAuthenticated</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>effectiveDeliveryPolicy</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>owner</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>pendingConfirmation</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sns/v1alpha1/topic/index.html b/reference/sns/v1alpha1/topic/index.html index ae8f86ef1d..550a6ef847 100644 --- a/reference/sns/v1alpha1/topic/index.html +++ b/reference/sns/v1alpha1/topic/index.html @@ -162,4 +162,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>effectiveDeliveryPolicy</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>owner</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>topicARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file diff --git a/reference/sqs/v1alpha1/queue/index.html b/reference/sqs/v1alpha1/queue/index.html index 3c9e9cf53e..aa61610959 100644 --- a/reference/sqs/v1alpha1/queue/index.html +++ b/reference/sqs/v1alpha1/queue/index.html @@ -160,4 +160,4 @@ </code></pre><table><thead><tr><th>Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>ackResourceMetadata</strong><br>Optional</td><td><strong>object</strong><br>All CRs managed by ACK have a common <code>Status.ACKResourceMetadata</code> member<br>that is used to contain resource sync state, account ownership,<br>constructed ARN for the resource</td></tr><tr><td><strong>ackResourceMetadata.arn</strong><br>Optional</td><td><strong>string</strong><br>ARN is the Amazon Resource Name for the resource. This is a<br>globally-unique identifier and is set only by the ACK service controller<br>once the controller has orchestrated the creation of the resource OR<br>when it has verified that an “adopted” resource (a resource where the<br>ARN annotation was set by the Kubernetes user on the CR) exists and<br>matches the supplied CR’s Spec field values.<br>TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse<br>https://github.com/aws/aws-controllers-k8s/issues/270</td></tr><tr><td><strong>ackResourceMetadata.ownerAccountID</strong><br>Required</td><td><strong>string</strong><br>OwnerAccountID is the AWS Account ID of the account that owns the<br>backend AWS service API resource.</td></tr><tr><td><strong>ackResourceMetadata.region</strong><br>Required</td><td><strong>string</strong><br>Region is the AWS region in which the resource exists or will exist.</td></tr><tr><td><strong>conditions</strong><br>Optional</td><td><strong>array</strong><br>All CRS managed by ACK have a common <code>Status.Conditions</code> member that<br>contains a collection of <code>ackv1alpha1.Condition</code> objects that describe<br>the various terminal states of the CR and its backend AWS service API<br>resource</td></tr><tr><td><strong>conditions.[]</strong><br>Required</td><td><strong>object</strong><br>Condition is the common struct used by all CRDs managed by ACK service</td></tr><tr><td>controllers to indicate terminal states of the CR and its backend AWS</td><td></td></tr><tr><td>service API resource</td><td></td></tr><tr><td><strong>conditions.[].message</strong><br>Optional</td><td><strong>string</strong><br>A human readable message indicating details about the transition.</td></tr><tr><td><strong>conditions.[].reason</strong><br>Optional</td><td><strong>string</strong><br>The reason for the condition’s last transition.</td></tr><tr><td><strong>conditions.[].status</strong><br>Optional</td><td><strong>string</strong><br>Status of the condition, one of True, False, Unknown.</td></tr><tr><td><strong>conditions.[].type</strong><br>Optional</td><td><strong>string</strong><br>Type is the type of the Condition</td></tr><tr><td><strong>queueARN</strong><br>Optional</td><td><strong>string</strong><br></td></tr><tr><td><strong>queueURL</strong><br>Optional</td><td><strong>string</strong><br>The URL of the created Amazon SQS queue.</td></tr></tbody></table><div class=my-n3></div></main></div></div></div><footer class="footer mt-auto text-muted"><div class=container><div class=row><div class="col-lg-8 order-last order-lg-first"><ul class=list-inline><li class=list-inline-item>Powered by <a href=https://gohugo.io/>Hugo</a> and <a href=https://getdoks.org/>Doks</a></li></ul></div><div class="col-lg-8 order-first order-lg-last text-lg-end"><ul class=list-inline></ul></div></div></div></footer><script src=https://aws-controllers-k8s.github.io/community/js/bootstrap.min.b215b4cd9b395d6674fe820a7dfe831d833cf64feef865325eb6e3256a4cf84110a040b38af60cdecabe307668c218a83a96ff6f1aa1dade51fc78195449e610.js integrity="sha512-shW0zZs5XWZ0/oIKff6DHYM89k/u+GUyXrbjJWpM+EEQoECzivYM3sq+MHZowhioOpb/bxqh2t5R/HgZVEnmEA==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/js/highlight.min.845ac7a35070c98e709cb2c243868ea6535713a4e36512571d6995b58dc2e9710dc129f61e35d985044dea835379d832388bc7449de083d2d1e208bf015920fc.js integrity="sha512-hFrHo1BwyY5wnLLCQ4aOplNXE6TjZRJXHWmVtY3C6XENwSn2HjXZhQRN6oNTedgyOIvHRJ3gg9LR4gi/AVkg/A==" crossorigin=anonymous defer></script> <script src=https://aws-controllers-k8s.github.io/community/main.min.f2b231c301bb6bb703581a2ab160f506b26c9b58a8321a04bff902e06cf229ac0c6d21eeb75cab5a14e5d6f4dd54753134874d6cab025313d1c9b6e8dbe649b5.js integrity="sha512-8rIxwwG7a7cDWBoqsWD1BrJsm1ioMhoEv/kC4GzyKawMbSHut1yrWhTl1vTdVHUxNIdNbKsCUxPRybbo2+ZJtQ==" crossorigin=anonymous defer></script> -<script src=https://aws-controllers-k8s.github.io/community/index.min.f881283bd3bc9b53ad151e123fcbeaa0cdf81e66dba8a31034348ac3a6d5bd298ad438be3ce7d3dfc72cd645ca97712887f13ffe756943382260e9bbd5e6dbf3.js integrity="sha512-+IEoO9O8m1OtFR4SP8vqoM34HmbbqKMQNDSKw6bVvSmK1Di+POfT38cs1kXKl3Eoh/E//nVpQzgiYOm71ebb8w==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file +<script src=https://aws-controllers-k8s.github.io/community/index.min.e161f0a81cfd8eadd5ae4ca1cccfa1455b939efab7c76b61a339aef290fddc68cf73d5b4d373a9072249a5807c6f507e0935c1eb838c77ef76cf6216106622fa.js integrity="sha512-4WHwqBz9jq3VrkyhzM+hRVuTnvq3x2thozmu8pD93GjPc9W003OpByJJpYB8b1B+CTXB64OMd+92z2IWEGYi+g==" crossorigin=anonymous defer></script></body></html> \ No newline at end of file